🎯

csharp-docs

🎯Skill

from github/awesome-copilot

What it does

Ensures C# types are documented with XML comments following best practices.

Overview

This skill ensures C# types are properly documented with XML comments following established best practices. It covers documentation standards for all public and internal members including classes, methods, properties, events, and generic types, with guidance on summary writing, parameter documentation, return values, exceptions, code examples, and cross-references.

Key Features

XML Comment Standards - Enforces proper use of <summary>, <remarks>, <param>, <returns>, <exception>, <example>, and <seealso> tags following Microsoft documentation conventions
Method Documentation - Guides parameter descriptions as noun phrases, Boolean parameter wording patterns, return value documentation for async/Task methods, and exception documentation
Code Example Formatting - Structures examples with <example> containing <code language="csharp"> blocks for proper rendering in generated documentation
Cross-Reference System - Uses <see cref> for inline type references, <see langword> for C# keywords, and <seealso> for standalone related type references
Inheritance Documentation - Applies <inheritdoc/> for inherited members unless behavior differs significantly, reducing documentation duplication across class hierarchies

Who is this for?

C# developers and teams who need to maintain consistent, high-quality XML documentation across their codebases. Ideal for library authors, API developers, and teams using documentation generation tools where comprehensive XML comments directly impact the quality of generated API documentation.

📦

Same repository

github/awesome-copilot(224 items)

csharp-docs

Installation

Vibe Index InstallInstalls to .claude/skills/ - auto-recognized by Claude Code

npx vibeindex add github/awesome-copilot --skill csharp-docs

skills.sh Install⚠ Installs to .agents/skills/ - may not be auto-recognized by Claude Code

npx skills add github/awesome-copilot --skill csharp-docs

Manual InstallCopy SKILL.md content and save to the path below

~/.claude/skills/csharp-docs/SKILL.md

SKILL.md

6,885Installs

AddedFeb 25, 2026

View on GitHub Back to Skills

More from this repository10

🎯

git-commit🎯Skill

A community-curated collection of custom agents, prompts, instructions, and skills to enhance GitHub Copilot across different domains, languages, and use cases.

🎯

gh-cli🎯Skill

A community-curated collection of custom agents, prompts, instructions, and skills to enhance GitHub Copilot across different domains, languages, and use cases.

🎯

prd🎯Skill

Generates comprehensive Product Requirements Documents (PRDs) by systematically analyzing requirements and crafting detailed technical specifications

🎯

refactor🎯Skill

A community-curated collection of custom agents, prompts, instructions, and skills to enhance GitHub Copilot across different domains, languages, and use cases.

🎯

excalidraw-diagram-generator🎯Skill

Generates Excalidraw diagrams from natural language descriptions, creating visual representations of processes, systems, relationships, and ideas.

🎯

documentation-writer🎯Skill

Expert technical writer guided by the Diataxis framework, creating tutorials, how-to guides, reference docs, and explanation pages for software documentation.

🎯

chrome-devtools🎯Skill

Automates browser interactions, debugging, and performance analysis using Chrome DevTools for comprehensive web page inspection and control.

🎯

java-springboot🎯Skill

Provides Spring Boot best practices covering project setup, dependency injection, REST API design, data access with JPA, security configuration, and testing strategies.

🎯

web-design-reviewer🎯Skill

A community-curated collection of custom agents, prompts, instructions, and skills to enhance GitHub Copilot across different domains, languages, and use cases.

🎯

github-issues🎯Skill

Manages GitHub Issues through the GitHub API, enabling creation, searching, labeling, and triaging of issues directly from the coding environment.