dotnet-document

Writes and reviews XML documentation comments on C# members against compiler and Roslynator diagnostics.

Updated Jun 30, 2026
One-click install
npx skills add https://github.com/bsamiee/Rasm --skill dotnet-document-bsamiee
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: dotnet-document
Source: https://github.com/bsamiee/Rasm/tree/main/.claude/skills/dotnet-document
Command: npx skills add https://github.com/bsamiee/Rasm --skill dotnet-document-bsamiee

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? C# XML doc comments must satisfy strict compiler and analyzer rules (CS1570, CS1573, CS1574, RCS1228, MA0219, and more), and hand-written documentation often drifts from the actual source code, producing build failures or fabricated claims. This Skill provides the exact tag syntax, per-member-kind phrasing conventions, and a severity-classed review procedure to keep documentation accurate and build-clean. ## Core Features & Use Cases - Doc Comment Authoring: Complete syntax reference for <summary>, <param>, <returns>, <exception>, <example>, cref cross-references, and escaping rules, with the exact diagnostic each mistake triggers. - Member-Kind Phrasing: Standard opening phrases and tag sets for classes, constructors, properties, methods, events, enums, parameters, and return values, including LanguageExt return types like Option<A> and Fin<A>. - Source-Verified Review: A review workflow that reads the C# source first, checks doc claims against declarations and method bodies, and classifies findings as CRITICAL, IMPORTANT, or MINOR. - Use Case: A build fails with CS1573 and RCS1228 after adding a new public method. Use this Skill to write a compliant doc comment with correct parameter order, non-empty tags, and the standard phrasing for the member kind. ## Quick Start Review the XML doc comments in Drawing/Paint.cs against its source and report findings by severity.

Frequently Asked Questions about dotnet-document

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write XML doc comments in C# that pass the build?▼

Write a one-line third-person <summary>, document every parameter in declaration order with <param>, and add <returns> and <exception> tags as needed. Empty elements fail RCS1228 and missing parameters fail CS1573, so cover all parameters or none.

How to fix CS1573 and CS1574 doc comment warnings?▼

CS1573 means some parameters lack <param> tags; document every parameter in declaration order or none. CS1574 means a cref target cannot be resolved; check the name against the using directives and use the List{T} form for generics.

What is the standard summary phrase for C# constructors and properties?▼

Constructors open with "Initializes a new instance of the <see cref> class". Properties open with "Gets", "Gets or sets", or "Gets or initializes" depending on the accessor list, and boolean properties use "Gets a value that indicates whether".

Why does CS1570 fail on my XML documentation comment?▼

CS1570 fires on malformed XML in doc comments, most often unescaped <, >, or & characters in the text. Replace them with &lt;, &gt;, and &amp;, and check for missing closing tags or mismatched tag names.

When should I use inheritdoc instead of writing C# doc comments?▼

Use <inheritdoc/> on overrides and interface implementations to copy base documentation, since the compiler writes nothing to the XML file without it. Add cref to copy from a named member and path to filter copied tags with XPath.