Recommended Tags for Documentation Comments (C# Programming Guide)
The C# compiler processes documentation comments in your code and formats them as XML in a file whose name you specify in the /doc command-line option. To create the final documentation based on the compiler-generated file, you can create a custom tool, or use a tool such as DocFX or Sandcastle.
Tags are processed on code constructs such as types and type members.
Documentation comments cannot be applied to a namespace.
The compiler will process any tag that is valid XML. The following tags provide generally used functionality in user documentation.
(* denotes that the compiler verifies syntax.)
If you want angle brackets to appear in the text of a documentation comment, use
>, as shown in the following example.
/// <summary cref="C < T >"> /// </summary>
We'd love to hear your thoughts. Choose the type you'd like to provide:
Our feedback system is built on GitHub Issues. Read more on our blog.