Compartir a través de

Recommended Tags for Documentation Comments (C# Programming Guide) 

  • Artículo

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

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:

<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 &lt; and &gt;. For example, &lt;text in angle brackets&gt;.

See Also

Tasks

XML Documentation Sample

Reference

/doc (Process Documentation Comments) (C# Compiler Options)

Concepts

C# Programming Guide
XML Documentation Comments (C# Programming Guide)
XML Documentation Comments (C# Programming Guide)