C# XML Documentation Guide
Makes the agent write C# XML doc comments following Microsoft-style conventions.
- Repository
- github/awesome-copilot
- Stars
- 40,703
- Licence
- MIT
- Files
- 1 file
What it does
When you ask the agent to document C# code, it follows a set of written rules for XML comments such as summary, param, returns, and exception tags. Wording patterns are specified for common cases, for example how a summary for a property or constructor should begin, or how a Boolean return value should be described. The skill is guidance only: it tells the agent how to write documentation but does not run tools or check the result automatically.
Great for
- C# developers who want consistent XML doc comments across a library
- Teams preparing public APIs for generated online reference docs
- Anyone reviewing or rewriting existing C# comments to match a style
Skip it if
- Non-C# projects, since the rules only cover C# XML comments (use a skill for the relevant language instead)
- Projects with their own documentation standard that conflicts with these conventions, because the agent will follow this skill's wording rules
Try asking
- “Add XML documentation comments to this C# class and its public methods.”
- “Review my C# service file and fix the summary and param tags to match best practices.”
- “Write <exception> entries for the methods in this repository's Data layer.”
- “Document the boolean properties in this C# model with correct wording.”
Install in 3 steps
- 1
Download the skill
The ZIP contains the 1 original files, the MIT licence and an attribution note.
csharp-docs.zip - 2
Add it to your agent
Claude Code (all projects)
mkdir -p ~/.claude/skills && unzip csharp-docs.zip -d ~/.claude/skills/Claude Code / Agent SDK (this project only)
mkdir -p .claude/skills && unzip csharp-docs.zip -d .claude/skills/Claude apps (web/desktop): Settings → Capabilities → Skills → Upload skill, and choose the ZIP.
- 3
Ask for the task
No special command needed — the agent reads the skill's description and loads it when your request matches. Try one of the prompts above.
Get better results
- Paste or point to the specific C# files you want documented so the agent can match the actual signatures.
- Review the generated comments for accuracy, since the agent infers behaviour from the code and can misdescribe it.
- Ask the agent to skip internal members if you only want public API documentation, as the guidance treats internal documentation as optional.
What's inside
- SKILL.md
Redistributed unmodified from github/awesome-copilot under the MIT licence. The assessment was drafted with AI from the skill's files on 2026-10-29. Skills can instruct your agent to run code — read SKILL.md and any scripts before installing.