Skip to content
Open core software, built in Singapore Established 2018  /  Five utilities
Jering
Talk to us

XML Documentation

DevOps.AzurePipelines Jering documentation Open source Pipeline templates
Documentation menu

XML documentation turns public API comments into tooltips and generated reference pages. It is the cheapest documentation a library can ship.

Enable generation

Turn on XML documentation generation in the project file and treat missing comments on public members as a warning worth reviewing. The compiler emits an XML file beside the assembly.

Write for the reader

Describe what a member does, what it returns and when it throws. Avoid restating the method name. A short example in the remarks section is often more useful than another paragraph.

Ship the file

Include the XML file in the package so consumers see the comments in their editor. A package without XML documentation forces every consumer to open the source.

Reference shelf