csharp-xml-docs

Generates C# XML documentation comments using a Haiku draft, expert review, and approval workflow.

Updated May 22, 2026
One-click install
npx skills add https://github.com/viniciuscs84/sdd-toolkit --skill csharp-xml-docs-viniciuscs84
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: csharp-xml-docs
Source: https://github.com/viniciuscs84/sdd-toolkit/tree/main/skills/csharp-xml-docs
Command: npx skills add https://github.com/viniciuscs84/sdd-toolkit --skill csharp-xml-docs-viniciuscs84

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Writing consistent, high-quality XML documentation for C# APIs is tedious and often inconsistent across teams, especially when projects mix Korean and English documentation or follow strict style standards like POCU naming conventions. ## Core Features & Use Cases - Pattern-Based Documentation: Provides a complete pattern library covering properties, methods, classes, enums, extension methods, factory methods, and interface-vs-implementation documentation using <inheritdoc/>. - 3-Step Review Workflow: Generates drafts with Claude-Haiku, refines them through Gemini or Codex CLI expert review, and requires final manual approval before integration. - Flexible Language Support: Supports pure Korean, pure English, or mixed bilingual documentation with consistency rules and formatting guidance for tags like <remarks>, <value>, <exception>, and <para>. - Use Case: When adding XML docs to a Unity C# interface and its implementation, the skill produces full contract documentation on the interface and concise <inheritdoc/> plus implementation notes on the class. ## Quick Start Ask the AI to generate XML documentation for a specific C# method, class, or interface following the csharp-xml-docs patterns and your preferred language.

Frequently Asked Questions about csharp-xml-docs

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

FAQPage Schema
How do I add XML documentation to C# methods and properties?

Request documentation for a specific member, and the skill generates a draft following its pattern library: concise `<summary>` for simple members, `<remarks>` for complex concepts, and `<param>`/`<returns>` for methods. The draft is then refined through an expert review step before approval.

How should I document a C# interface versus its implementation?

Write full documentation on the interface covering the API contract, parameters, return semantics, and preconditions. On the implementation class, use `<inheritdoc/>` plus brief remarks describing only implementation-specific behavior such as routing logic or failure modes.

Can C# XML documentation be written in Korean or mixed languages?

Yes, the skill supports pure Korean, pure English, or mixed bilingual documentation. The key rule is consistency: use one language strategy within a single file and across related components, and document the choice in the project README.

When should I use the <value> tag on C# properties?

Use `<value>` only when a getter or setter has side effects or non-obvious behavior, such as triggering a system switch. Simple auto-properties and computed properties need only a `<summary>` tag.

Does this skill automatically add XML documentation to my code?

No, documentation is never auto-applied. It is generated only when explicitly requested, then goes through Haiku drafting, Gemini or Codex expert review, and final manual approval before integration.