csharp-docs

Enforce XML comment conventions for C# public APIs and Godot scripts.

Updated Apr 18, 2026
One-click install
npx skills add https://github.com/Zearain/ludum-dare-59 --skill csharp-docs-zearain
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: csharp-docs
Source: https://github.com/Zearain/ludum-dare-59/tree/main/.opencode/skills/csharp-docs
Command: npx skills add https://github.com/Zearain/ludum-dare-59 --skill csharp-docs-zearain

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

XML documentation conventions ensure consistent, high-quality XML comments across C# public APIs, improving maintainability and editor support.

Core Features & Use Cases

  • Use <summary> to document public types and members.
  • Use <remarks>, <param>, <returns>, <typeparam>, <value>, and <exception> to provide additional context and usage guidance.
  • Include guidance for Godot exported properties and signal delegates.

Quick Start

Annotate all public APIs with XML comments following the guidelines in this document.

Frequently Asked Questions about csharp-docs

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

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

To write XML documentation for C# public APIs, use <summary> tags for types and members, and supplement them with <remarks>, <param>, <returns>, <typeparam>, <value>, and <exception> tags to provide comprehensive usage context.

What is the best way to document Godot exported properties and signal delegates in C#?

Documenting Godot exported properties and signal delegates in C# requires applying specific XML comment conventions to the public surface, ensuring editor support and maintainability for game scripts.

When do I need to use <inheritdoc/> and <remarks> tags in C# documentation?

You need to use <inheritdoc/> to inherit documentation from base members and <remarks> to add supplementary context, ensuring your C# XML comments satisfy strict consistency requirements across the entire public API.

Does this XML documentation convention work for both C# libraries and game scripts?

Yes, these XML documentation conventions apply to both C# libraries and Godot game scripts, enforcing consistent tag usage across the public surface, exported properties, and signal delegates.

How do I enforce consistent XML comment conventions across a C# codebase?

You can enforce consistent XML comment conventions by applying guidelines that mandate <summary> usage for public types and members, alongside <param>, <returns>, and <exception> tags to solve documentation inconsistencies.

Why does my C# public API lack clear editor support and maintainability?

Your C# public API lacks clear editor support because of inconsistent XML comments, which you can fix by enforcing standard tag usage like <summary>, <remarks>, and <typeparam> across all public types and members.