What are the C# documentation tags? [closed]
-
09-06-2019 - |
Question
In C# documentation tags allow you to produce output similar to MSDN. What are a list of allowable tags for use inside the /// (triple slash) comment area above classes, methods, and properties?
Solution
Check out Great documentation on the various C# XML documentation tags. (Go to the bottom to see the tags)
OTHER TIPS
If you type this just above a method or class, intellisense should prompt you with a list of available tags:
/// <
Here's a list:
- summary
- param
- returns
- example
- code
- see
- seealso
- list
- value
- file
- copyright
Here's an example:
<file> <copyright>(c) Extreme Designers Inc. 2008.</copyright> <datecreated>2008-09-15</datecreated> <summary> Here's my summary </summary> <remarks> <para>The <see cref="TextReader"/> can be used in the following ways:</para> <list type="number"> <item>first item</item> <item>second item</item> </list> </remarks> <example> <code> System.Console.WriteLine("Hello, World"); </code> </example> <param name="aParam">My first param</param> <returns>an object that represents a summary</returns> </file>
MSDN article from 2002 detailing all the tags and when to use them:
GhostDoc helps by creating a stub comment for your method/class.
See the excellent MSDN article here as your first stop.
Look inside the docs for Sandcastle. This is the new documentation standard for .NET.