CSharp - XML Documentation Standard Tags

  1. HOME
  2. CSharp
  3. Statement
  4. XML Documentation Standard Tags

Introduction

The following table lists the standard XML tags that Visual Studio and documentation generators recognize:

Tag
 Usage
<summary>

 <summary>...</summary>
a single phrase or sentence to describe the usage of a field or a type
<remarks>


 <remarks>...</remarks>
Additional text that describes the type or member. Documentation generators
pick this up and merge it into the bulk of a type or member's description.
<param>

 <param name="name">...</param>
Explains a parameter on a method.
<returns>

 <returns>...</returns>
Explains the return value for a method.
<exception>

 <exception [cref="type"]>...</exception>
Lists an exception that a method may throw (cref refers to the exception type).
<permission>

 <permission [cref="type"]>...</permission>
Indicates an IPermission type required by the documented type or member.
<example>


 <example>...</example>
Denotes an example.
This usually contains both description text and source code marked within a <c> or <code> tag.
<c>

 <c>...</c>
Indicates an inline code snippet. This tag is usually used inside an <example> block.
<code>

 <code>...</code>
Indicates a multiline code sample. This tag is usually used inside an <example> block.
<see>

 <see cref="member">...</see>
Inserts an inline cross-reference to another type or member. Tools convert this to a hyperlink.
<seealso>

 <seealso cref="member">...</seealso>
Cross-references another type or member.
<paramref>

 <paramref name="name"/>
References a parameter from within a <summary> or <remarks> tag.
<list>










 <list type=[ bullet | number | table ]>
<listheader>
<term> ...</term>
<description> ...</description>
</listheader>
<item>
<term> ...</term>
<description> ...</description>
</item>
</list>
Instructs documentation generators to emit a bulleted, numbered, or table-style list.
<para>

 <para>...</para>
Instructs documentation generators to format the contents into a separate paragraph.
<include>


 <include file='filename ' path='tagpath[@name="id"]'>...</include>
Merges an external XML file that contains documentation. The path attribute
denotes an XPath query to a specific element in that file.