C# Documentation Best Practices

When to Use

• Writing or reviewing XML documentation comments (///) on C# types and members
• Adding documentation to public APIs of a new or existing C# library
• Reviewing missing, insufficient, or non-Microsoft-style XML docs in C# code
• Generating documentation that feeds OpenAPI/Swagger output or NuGet symbols

General Guidelines

• Public members should be documented with XML comments.
• It is encouraged to document internal members as well, especially if they are complex or not self-explanatory.

Guidance for all APIs