Recommended Tags for Documentation Comments
Important This document may not represent best practices for current development, links to downloads and other resources may no longer be valid. Current recommended version can be found here. ArchiveDisclaimer

Recommended Tags for Documentation Comments

The C# compiler will process documentation comments in your code to an XML file. Processing the XML file to create documentation is a detail that needs to be implemented at your site.

Tags are processed on code constructs such as types and type members.

Note   Tags are not processed on namespaces.

The compiler will process any tag that is valid XML. The following tags provide commonly used functionality in user documentation:

1. Compiler verifies syntax.

See Also

/doc (Process Documentation Comments) | XML Documentation

© 2015 Microsoft