How to use the C# XML Documentation Guide agent skill

What the csharp-docs skill makes the agent do

When you ask the agent to document C# code, this skill tells it to follow a specific set of XML comment conventions. Public members should be documented, and internal members are encouraged when they are complex or not self-explanatory.

The skill is guidance only. It tells the agent how to write documentation but does not run tools or check the result automatically, so you still need to review the output.

• summary: one sentence, starting with a present-tense, third-person verb
• remarks: extra implementation details, usage notes or context
• param and returns: noun phrases that do not state the data type
• exception: the condition under which the exception is thrown, stated directly
• inheritdoc: inherit documentation from base classes or interfaces, unless behaviour changes majorly

Install the csharp-docs skill

Download the ZIP file from this page. You have two options for installing it.

Option one is to unzip it into your personal skills folder at ~/.claude/skills/, or into a project's .claude/skills/ folder if you want the skill only for that project.

Option two is to upload the ZIP in the Claude apps. Go to Settings, then Capabilities, then Skills, and upload the file there.

• Personal install: unzip into ~/.claude/skills/
• Project install: unzip into the project's .claude/skills/ folder
• Claude apps: Settings → Capabilities → Skills, then upload the ZIP

How to ask the agent to use it

You do not need a special command. Ask in plain language that names C# and documentation or XML comments. Be specific about the scope, such as one class, a whole file, or a public API.

Good requests name the code and the goal. For example, you might ask the agent to add XML comments to every public member of a class, or to review existing comments and rewrite them to match the style rules.

• "Add XML doc comments to the public members of this C# class."
• "Document the constructors and properties in this file using our C# XML comment conventions."
• "Review these C# comments and rewrite any that do not follow the csharp-docs rules."

Know the wording rules the agent will follow

The skill sets exact wording for common cases. Constructor summaries follow one pattern, and property summaries depend on whether the property is read-only, read-write or Boolean. Boolean parameters and return values also follow fixed forms.

Seeing these rules helps you check the output quickly.

• Constructor summary: "Initializes a new instance of the <Class> class [or struct]."
• Read-write property: starts with "Gets or sets..."
• Read-only property: starts with "Gets..."
• Boolean property: starts with "Gets [or sets] a value that indicates whether..."
• Boolean return value: "true if ...; otherwise, false."
• Out parameter: "When this method returns, contains ...." followed by "This parameter is treated as uninitialized."

Safety notes: scripts and network

The skill runs no scripts and uses no network access, according to its listing. It needs nothing else to be installed. The only file it includes is SKILL.md.

Because it only shapes the agent's writing, the main risk is a documentation style that does not match your project. Review changes before committing them.

• Runs scripts: no
• Uses network: no
• Requirements listed: none
• Files included: SKILL.md

Tips for getting good results

Give the agent the scope and the audience. Public API comments and internal helper comments can need different levels of detail.

If your team has its own documentation standard, check whether it conflicts with these conventions before you use the skill. The agent will follow this skill's wording rules.

• Ask for one file or type at a time so you can review each change.
• Use the examples and code tags only where usage is helpful.
• Check that generated summaries start with the required wording and are one sentence.