
csharp-docs
XML documentation standards and patterns for C# public APIs and members
by githubFree
Description
csharp-docs is an agent skill from the github/awesome-copilot collection that sets out the XML documentation standards for C# types and members. Public members should carry XML comments, and internal members should be documented too when they are complex or not self-explanatory. The skill explains which XML tags to use and when. A summary tag holds one sentence that starts with a present-tense, third-person verb, and remarks hold implementation details, usage notes or other context. The example and code tags show usage, with a language attribute on code blocks, and the see tags link to other types and members, either inline in a sentence or in a see-also section of the online docs. The inheritdoc tag pulls documentation from base classes or interfaces, except where behavior changes, in which case the differences should be documented. The skill applies when writing or reviewing documentation for a C# library or API, and it is useful for teams that publish a library whose members need to show up correctly in IntelliSense and in generated reference documentation. Good XML comments stay accurate only when they are kept with the code, so the documentation should be updated in the same change as the behavior it describes. The skill is installed with the skills CLI from the github/awesome-copilot repository. Its skills.sh page showed about 9.6K installs and passing results from three security audits at the time of the scan.…
Highlights
- XML documentation for public and complex internal members
- Present-tense summary convention
- Remarks, examples and code blocks
- Cross references with see and seealso
- Inheritdoc and documented behavior changes
- Installs with the skills CLI
Ratings & Reviews
No ratings yet
Be the first to rate csharp-docs.
People also visit

csharp-nunit
NUnit best practices for standard and data-driven unit testing in .NET projects

csharp-xunit
Comprehensive XUnit testing guide covering standard facts, data-driven theories

creating-oracle-to-postgres-master-migration-plan
Discovers all projects in a .NET solution

creating-oracle-to-postgres-migration-integration-tests
Creates integration test cases targeting Oracle for .NET data access artifacts
csharp-docs FAQ
Which members should be documented?
Public members should have XML comments, and internal members too when they are complex or not self-explanatory.
How should the summary read?
As one sentence starting with a present-tense, third-person verb.
When should inheritdoc be used?
To inherit documentation from base classes or interfaces, unless the behavior changes, in which case the differences should be written out.
How do I install it?
Run npx skills add https://github.com/github/awesome-copilot --skill csharp-docs.
What security audits does it have?
skills.sh lists three audits: Gen Agent Trust Hub Pass, Socket Pass and Snyk Pass.
What are the best csharp-docs alternatives?
Popular alternatives to csharp-docs include csharp-mcp-server-generator, csharp-nunit and csharp-xunit. See all csharp-docs alternatives







