VSdocman parses special tags when they are embedded within your comment. These tags enable you to autogenerate a complete, well-formatted documentation from your source code. There are two equivalent types of tags: XML tags defined by Microsoft or @-style.
Recommended XML comments are explained in detail here. Old @-style comments are explained here.
For more detail see also overview of commenting.
Supported tags are:
| XML Tag | @-style Tag | Meaning |
|---|---|---|
| <summary> | Main description of member. | |
| <seealso> | @see | Specifies See Also list. |
| <example> | @example | Specifies example. |
| <same> | @same | Takes comment from some other object.Obsolete. |
| <typeparam> | @typeparam | Describes type parameter for generic member. |
| <param> | @param | Describes function parameter. |
| <set> | @set | Describes settings for parameter. Obsolete. |
| <returns> | @return | Describes return value. |
| <remarks> | @rem | Remarks. |
| <author> | @author | Author. |
| <version> | @version | Version. |
| <revision> | @revision | Revision date. |
| <includesource> | @includesource | Whether to include source code in documentation. |
| <compilewhen> | @compilewhen | Specifies compilation condition. |
| <exception> | @exception | Describes exception. |
| user-defined | user-defined | User-defined tags. |
There are also several XML tags that have no @-style equivalent:
| XML Tag | Meaning |
|---|---|
| <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. |
| <font> | Font color. |