csharp-docs

Document C# public types and members with XML comments.

Updated Apr 22, 2026

Search Tags:#csharp #documentation #coding-standards #api-docs #xml-comments #documentation-best-practices

Ready to run

npx skills add https://github.com/iliasjennane/LearningAgent --skill csharp-docs-iliasjennane

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: csharp-docs
Source: https://github.com/iliasjennane/LearningAgent/tree/main/.agents/skills/csharp-docs
Command: npx skills add https://github.com/iliasjennane/LearningAgent --skill csharp-docs-iliasjennane

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

C# types often lack consistent XML documentation, making APIs harder to discover and maintain. This skill enforces XML comment usage and standard documentation practices to improve code understandability.

Core Features & Use Cases

Enforces XML documentation on public members (types, methods, properties, constructors).
Provides guidance on <summary>, <remarks>, <param>, <returns>, <exception>, <see>, and <example> tags with real-world examples.
Example use case: ensure a library class exposes well-documented public API for teammates and consumers.

Quick Start

Document a sample public class by adding XML comments for Summary, Remarks, See, and Example according to the guidelines.

Frequently Asked Questions about csharp-docs

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

FAQPage Schema

How do I document C# public methods with XML comments?▼

To document C# public methods with XML comments, add standard tags like <summary>, <param>, and <returns> directly above your method signatures. This ensures your API is discoverable and maintainable for library consumers.

What XML tags should I use for C# API documentation?▼

C# API documentation should use <summary>, <remarks>, <param>, <returns>, <exception>, <see>, and <example> tags. These tags provide structured guidance on public types, methods, properties, and constructors to improve code understandability.

How do I add <exception> and <example> tags to C# constructors?▼

Add <exception> and <example> tags above C# constructors to document thrown exceptions and demonstrate usage. Applying these XML comments to public constructors ensures your library API exposes well-documented real-world scenarios.

Does documenting C# properties with XML comments improve API discoverability?▼

Documenting C# properties with XML comments improves API discoverability by enforcing consistent documentation practices across public members. This standardizes code understandability for teammates and SDK consumers.

What is the best way to enforce coding standards for C# XML documentation?▼

The best way to enforce coding standards for C# XML documentation is to apply guidelines requiring <summary> and <remarks> tags on all public types, methods, and properties. This solves inconsistent API documentation in libraries.

When do I need XML comments in C# library development?▼

You need XML comments in C# library development when exposing public APIs, types, and constructors to consumers. Applying documentation best practices ensures your SDK remains maintainable and easily discoverable by teammates.