Recommended Tags for Documentation Comments (C# Programming Guide)

SOURCE： CLICK HERE

Recommended Tags for Documentation Comments (C# Programming Guide)

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.

 Tags

<c>	<para>	<see>*
<code>	<param>*	<seealso>*
<example>	<paramref>	<summary>
<exception>*	<permission>*	<typeparam>*
<include>*	<remarks>	<typeparamref>
<list>	<returns>	<value>

(* 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>.