Skip to content
C

csharp-docs

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

by githubFree

Launch
#1940in AI Skills
0In stores

Description

csharp-docs is an agent skill from the github/awesome-copilot collection that sets out the XML documentation standards for C# types and memb…

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

C

csharp-mcp-server-generator

Scaffold a production-ready C# MCP server

AI Skills
Launch
C

csharp-nunit

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

AI Skills
Launch
C

csharp-xunit

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

AI Skills
Launch
A

aspire

Code-first orchestration for polyglot distributed apps

AI Skills
Launch
C

creating-oracle-to-postgres-master-migration-plan

Discovers all projects in a .NET solution

AI Skills
Launch
C

creating-oracle-to-postgres-migration-integration-tests

Creates integration test cases targeting Oracle for .NET data access artifacts

AI Skills
Launch

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

Developer Stuff

Badges