csharp-xml-docs

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; }