csharp-xml-docs

Generate consistent XML documentation for C# APIs in Unity projects.

10|Updated Nov 21, 2025
One-click install
npx skills add https://github.com/creator-hian/claude-code-plugins --skill csharp-xml-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: csharp-xml-docs
Source: https://github.com/creator-hian/claude-code-plugins/tree/main/csharp-plugin/skills/csharp-xml-docs
Command: npx skills add https://github.com/creator-hian/claude-code-plugins --skill csharp-xml-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides a comprehensive guide to writing high-quality, consistent C# XML documentation, addressing challenges in clarity, language choice (Korean/English), and adherence to best practices for various code elements. This ensures maintainable and understandable APIs, improving developer experience and code quality.

Core Features & Use Cases

  • Flexible Language Support: Guidance on using pure Korean, pure English, or mixed language documentation to suit team and project needs.
  • Pattern Library: Complete examples for documenting properties, methods, classes, enums, exceptions, and extension methods.
  • Interface vs. Implementation: Critical pattern for documenting interfaces fully and using <inheritdoc/> for implementations to avoid redundancy.
  • Use Case: Document a new public API for a Unity game. Use this skill to ensure all classes, methods, and properties have clear, consistent XML comments, including handling exceptions and property side effects, in the team's preferred language.

Quick Start

Document this C# property with a summary and remarks: public bool Skipped { get; set; }

Frequently Asked Questions about csharp-xml-docs

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

FAQPage Schema
How do I write consistent XML documentation for C# APIs?

XML documentation in C# uses `///` comments to generate structured API docs. Write summary tags for classes and methods, remarks for context, and param/returns tags for parameters and return values. This creates clear, machine-readable documentation that IDE tooltips and documentation generators can consume.

Can I use XML docs with Unity C# projects?

Yes. XML documentation works with all C# code, including Unity projects. Apply it to public classes, interfaces, properties, and methods to document your game APIs. Use `<inheritdoc/>` in implementations to avoid repeating interface documentation.

What's the best way to document properties and methods in C#?

Document properties with summary and remarks tags; include property side effects if relevant. For methods, use summary, param tags for each parameter, returns for the result, and exception tags for thrown errors. Follow this pattern consistently across all API surfaces.

How do I handle mixed-language XML documentation in C#?

XML documentation supports pure Korean, pure English, or mixed-language comments depending on team preference. Choose one approach and apply it consistently across your codebase to maintain clarity and searchability in generated documentation.

Why should I document interfaces differently from implementations in C#?

Document interfaces fully with complete XML comments since they define the contract. Use `<inheritdoc/>` in implementations to inherit interface documentation, reducing duplication and keeping documentation maintainable as interfaces evolve.

Do I need XML docs for all C# code or just public APIs?

Focus on public APIs—classes, interfaces, methods, and properties exposed to other code. Internal implementation details need less formal documentation, but public surfaces require complete XML comments to help developers understand and use your API correctly.