csharp-docs

XML documentation standards and patterns for C# public APIs and members.

github ↓ 9.2k
Claude Code
View source ↗

What it does

  • 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.
  • Use <summary> to provide a brief, one sentence, description of what the type or member does. Start the summary with a present-tense, third-person verb.
  • Use <remarks> for additional information, which can include implementation details, usage notes, or any other relevant context.
  • Use <see langword> for language-specific keywords like null, true, false, int, bool, etc.
  • Use <c> for inline code snippets.
  • Use <example> for usage examples on how to use the member.

Derived from the skill's own SKILL.md documentation · extracted 2026-07-23

XML documentation standards and patterns for C# public APIs and members.

Source

Repository: https://github.com/github/awesome-copilot

csharp-docs FAQ

What does the csharp-docs skill do?

Ensure that C# types are documented with XML comments and follow best practices for documentation. 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.

How do I install csharp-docs?

Run: npx -y skills add https://github.com/github/awesome-copilot --skill csharp-docs --agent claude-code — the source lives at github.com/github/awesome-copilot.

Maintain csharp-docs?

Let people know it's listed here — add the badge (live metrics, light/dark aware) or a plain link to your README or docs.

csharp-docs on getagentictools
[![csharp-docs on getagentictools](https://getagentictools.com/badge/skills/github-awesome-copilot-csharp-docs.svg)](https://getagentictools.com/skills/github-awesome-copilot-csharp-docs?ref=badge)
npx agentictools info skills/github-awesome-copilot-csharp-docs

The second line is the CLI lookup for this page — handy in READMEs and docs.