Use C # XML document annotations to generate API help documents

XML document comment

<Summary> description </summary>
Description type or type member.
Description: The abstract of the object.

<Remarks> description </remarks>
Add information about a type to supplement the information specified by <summary>.
Description: Member description.

<Example> description </example>
Examples of usage or other library members. This usually involves using the <code> flag.
Description: A description of the sample code.

<Seealso cref = "member"/>
Specify the text to appear in the "see" section.
Member: Reference of members or fields that can be called through the current compilation environment. Member must be enclosed in double quotation marks.

<Typeparam name = "name"> description </typeparam>
A single type parameter that describes a generic type or method.
Name: name of the type parameter. Enclose the name in double quotation marks ("").
Description: description of the type parameter.

<Param name = "name"> description </param>
Describes a single parameter of a method.
Name: method parameter name. Enclose the name in double quotation marks ("").
Description: parameter description.

<Returns> description </returns>
Describes the return value of a method.
Description: description of the returned value.

<Value> property-description </value>
The value of the description attribute.
Property-description: description of the property.
 
<Permission cref = "member"> description </permission>
The access permission of the member. You can use the PermissionSet class to specify access to members.
Member: a reference to the permissions that can be obtained from the current compilation environment. Member must be enclosed in double quotation marks.
Description: description of Access to members.

<Exception cref = "member"> description </exception>
Specifies which exceptions may be thrown. This tag can be used in the definition of methods, properties, events, and indexers.
Member: An exception reference that can be obtained from the current compilation environment. Member must be enclosed in double quotation marks.
Description: exception description.
 
<C> text </c>
Mark the text in the description as code.
Text: indicates the text of the Code.

<Code> content </code>
Indicates multiple lines of text as code.
Content: indicates the text of the Code.
 
<See cref = "member"/>
Specify the link from the text.
Member: Reference of members or fields that can be called through the current compilation environment. Member should be placed in double quotation marks.
 
<Paramref name = "name"/>, <typeparamref name = "name"/>
Reference a parameter or a type parameter.
Member: name of the parameter to be referenced (name of the type parameter ). Enclose the name in double quotation marks ("").

<Para> content </para>
You can add paragraphs to text by using tags such as <summary>, <remarks>, or <returns>.
Content: paragraph text.

<List type = "bullet" | "number" | "table">
<Listheader>
<Term> term </term>
<Description> description </description>
</Listheader>
<Item>
<Term> term </term>
<Description> description </description>
</Item>
</List>

<Listheader> A block is used to define the title row in a table or definition list. When defining a table, you only need to provide one item for the item in the title.
Each item in the list is described by a <item> block. When creating a definition list, you must specify both the term and description. However, for a table, project symbol list, or number list, you only need to provide an item for description.
The number of <item> blocks in a list or table can be customized as needed.
Term: the item to be defined. This item is defined in description.
Description: The definition of an item or term in the project symbol list or number list.

In addition to Microsoft Sandcastle's document generation tool, you can also use DocsBuilder to generate a Help File Based on the Assembly and XML annotation document.

DocsBuilder can also generate any desired document content through a custom template file.