csharplang/spec/documentation-comments.md

Documentation comments

This content has moved to the dotnet/csharpstandard repository. The list below provides links to each heading in this section. The links specify the C# 6 branch, which is version when the specifications merged.

To view the text of the Microsoft spec before merging with the ECMA text, checkout the ms-spec-text tag in this repository.

• Documentation comments
  • Introduction
  • Recommended tags
    • <c>
    • <code>
    • <example>
    • <exception>)
    • <include>
    • <list>
    • <para>
    • <param>
    • <paramref>
    • <permission>
    • <remarks>
    • <returns>
    • <see>
    • <seealso>
    • <summary>
    • <value>
    • <typeparam>
    • <typeparamref>
  • Processing the documentation file
    • ID string format
    • ID string examples
  • An example
    • C# source code
    • Resulting XML