Click to Rate and Give Feedback
This page is specific to
Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:
C# Programming Guide
Recommended Tags for Documentation Comments (C# Programming Guide)

Updated: November 2007

The C# compiler reads documentation comments in your code and formats them as XML into a file whose name you specify in the /doc command line option. To create the final documentation based on the compiler-generated file, you can create a custom tool, or use a tool such as Sandcastle.

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

Note:

Documentation comments cannot be applied to a namespace.

The compiler will process any tag that is valid XML. The following tags provide generally 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>.

Tags What's this?: Add a tag
Community Content   What is Community Content?
Add new content RSS  Annotations
Processing
© 2008 Microsoft Corporation. All rights reserved. Terms of Use  |  Trademarks  |  Privacy Statement
Page view tracker