skills.rest
CloudyWing
CloudyWingCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

csharp-docs

Enforce consistent XML documentation for public C# APIs and members.

Updated Mar 1, 2026
Search Tags:#csharp#documentation#code-quality#api-docs#xml-comments#xml-docs
One-click install
npx skills add https://github.com/CloudyWing/ai-dotfiles --skill csharp-docs-cloudywing
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: csharp-docs
Source: https://github.com/CloudyWing/ai-dotfiles/tree/main/skills/csharp-docs
Command: npx skills add https://github.com/CloudyWing/ai-dotfiles --skill csharp-docs-cloudywing

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Enforces consistent, high-quality XML documentation for C# code to reduce ambiguity in public APIs, improve maintainability, and ensure generated or reviewed code follows a unified documentation style.

Core Features & Use Cases

  • Mandatory public documentation: Requires XML comments for public members and recommends documentation for complex internal members.
  • Tag usage and formatting rules: Specifies when to use <summary>, <remarks>, <param>, <returns>, <exception>, <see cref>, <inheritdoc/>, and how to format multi-line summaries and single-line param/return descriptions.
  • Boolean and property guidance: Defines phrasing for boolean parameters and properties and prescribes value descriptions for properties using <value>.
  • Use Case: During code generation or review, apply these rules to produce uniform API docs that are readable, searchable, and consumable by documentation tools.

Quick Start

Ask the assistant to add or fix XML documentation in 'MyClass.cs' following these C# XML documentation standards, ensuring multi-line summaries, properly formatted param and returns tags, boolean value wording, and explicit exception documentation.

Frequently Asked Questions about csharp-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I enforce consistent C# XML documentation across public APIs?▼

To enforce consistent C# XML documentation, apply standardized formatting rules to public members during code generation or review, ensuring multi-line summaries and properly formatted param, returns, and exception tags.

What is the standard format for boolean properties and parameters in C# XML docs?▼

The standard format for boolean properties and parameters in C# XML docs requires specific phrasing with explicit true and false references, ensuring value descriptions for properties use the <value> tag.

Do I need XML comments for internal members or just public classes in C#?▼

XML comments are mandatory for public classes and members in C#, while documenting complex internal members is recommended to reduce ambiguity and improve maintainability across the codebase.

What's the best way to add exception tags and see cref references in C# code?▼

The best way to add exception tags and see cref references is to explicitly document exceptions with <exception> tags and use <see cref> for cross-references, ensuring generated API docs are searchable and readable.

When should I use the inheritdoc tag instead of writing summary tags in C#?▼

You should use the <inheritdoc/> tag instead of writing <summary> tags when a member inherits behavior from a base class or interface, ensuring uniform documentation without duplicating descriptions across inherited members.

Related Skills

Explore More Software Engineering Skills→
kierunbkierunb

csharp-docs

Document public C# types with XML comments and enforce XML tag usage.

Community
Basic
FabienDehopreFabienDehopre

csharp-docs

Generates standardized XML comments and API documentation for C# code.

Community
Basic
ps-carvalhops-carvalho

code-quality

Provides refactoring patterns and guidelines for JavaScript/TypeScript projects.

Community
Advanced
dieu-donneedieu-donnee

code-documenter

Generate, format, and validate developer documentation from code comments and API specs.

Community
Intermediate