Documentation
How to document your code? Some of the recommended tags:
| Tag | Notes |
|---|---|
<summary> |
The <summary> tag should be used to describe a type or a type member. |
<remarks> |
Add information about a type or a type member, supplementing the information specified with |
<param>* |
A description for the parameter |
<paramref> |
indicates that a word in the code comments, for example in a <summary> or <remarks> block refers to a parameter |
<returns> |
The <returns> tag describes the return value. |
<exception>* |
lets you specify which exceptions can be thrown |
<value> |
The <value> tag lets you describe the value that a property represents. |
<c> |
Indicate that a line within a description should be marked as code. |
<code> |
The <code> tag is used to indicate multiple lines of code. |
<para> |
paragraph, lets you add structure to the text |
<list> |
The <listheader> block is used to define the heading row of either a table or definition list |
<see> |
The <see> tag lets you specify a link from within text. |
<seealso>* |
lets you specify the text that you might want to appear in a See Also section |
Links
Offical C# documentation guide