VSdocman parses special XML tags when they are embedded within your comment. These tags enable you to autogenerate a complete, well-formatted documentation from your source code.

XML comments are explained in detail here. For more detail see also overview of commenting.

Supported tags are:

XML Tag

Meaning

<summary>

Main description of member.

<seealso>

Specifies See Also list.

<example>

Specifies example.

<typeparam>

Describes type parameter for generic member.

<param>

Describes function parameter.

<paramref>

Reference to parameter.

<typeparamref>

Reference to type parameter.

<returns>

Describes return value.

<remarks>

Remarks.

<author>

Author.

<version>

Version.

<revision>

Revision date.

<include>

Includes comment from external XML file.

<includesource>

Whether to include source code in documentation.

<compilewhen>

Specifies compilation condition.

<permission>

Documents the access of a member

<threadsafety>

Describe how a type behaves in multi-threaded scenarios.

<exception>

Describes exception.

user-defined

User-defined tags.

<value>

Value of property.

<para>

Paragraph.

<code>

Code block.

<c>

Inline code.

<see>

Inline link.

<list>

Bulleted or Numbered list or table.

<img>

Picture.

<b>

Bold.

<i>

Italic.

<u>

Undeline.

<br>

Line break, newline.

<font>

Font color.

See Also