Export (0) Print
Expand All
11 out of 39 rated this helpful - Rate this topic

Recommended Tags for Documentation Comments (C# Programming Guide)

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.

NoteNote

Documentation comments cannot be applied to a namespace.

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

(* denotes that the compiler verifies syntax.)

If you want angle brackets to appear in the text of a documentation comment, use < and >. For example, <text in angle brackets>.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.