csharp-docs

Overview

This skill ensures C# types are properly documented with XML comments following established best practices. It covers documentation standards for all public and internal members including classes, methods, properties, events, and generic types, with guidance on summary writing, parameter documentation, return values, exceptions, code examples, and cross-references.

Key Features

• XML Comment Standards - Enforces proper use of <summary>, <remarks>, <param>, <returns>, <exception>, <example>, and <seealso> tags following Microsoft documentation conventions
• Method Documentation - Guides parameter descriptions as noun phrases, Boolean parameter wording patterns, return value documentation for async/Task methods, and exception documentation
• Code Example Formatting - Structures examples with <example> containing <code language="csharp"> blocks for proper rendering in generated documentation
• Cross-Reference System - Uses <see cref> for inline type references, <see langword> for C# keywords, and <seealso> for standalone related type references
• Inheritance Documentation - Applies <inheritdoc/> for inherited members unless behavior differs significantly, reducing documentation duplication across class hierarchies

Who is this for?

C# developers and teams who need to maintain consistent, high-quality XML documentation across their codebases. Ideal for library authors, API developers, and teams using documentation generation tools where comprehensive XML comments directly impact the quality of generated API documentation.