Enforce XML documentation standards for public and internal C# members.
npx skills add https://github.com/markarnoldutah/RVS --skill csharp-docs-markarnoldutah
Please help me install this Agent Skill. Skill: csharp-docs Source: https://github.com/markarnoldutah/RVS/tree/main/.github/skills/csharp-docs Command: npx skills add https://github.com/markarnoldutah/RVS --skill csharp-docs-markarnoldutah
This Skill ensures that C# code is well-documented using XML comments, adhering to best practices for clarity and maintainability.
Ensure that all public members in the C# project are documented with XML comments.
High-intent search queries and answers about installing and using this skill.
The best way to enforce XML documentation standards for C# code is to apply rules ensuring public and internal members have proper comments. This covers summaries, remarks, parameters, return values, and exceptions to improve maintainability.
To document C# public and internal members, add XML comments for summaries, remarks, parameters, type parameters, return values, constructors, properties, and exceptions. This ensures consistent API documentation and improves developer understanding.
You need XML comments for C# API documentation when maintaining consistent, high-quality standards across a project. Documenting summaries, exceptions, and code examples makes it easier for developers to understand and use the code.
Yes, this C# documentation guidance covers exceptions and type parameters. It provides detailed instructions on documenting summaries, remarks, parameters, return values, constructors, properties, and code examples for improved code maintainability.
A limitation of enforcing XML documentation for C# code is that it focuses strictly on public and internal members, requiring established best practices for summaries and remarks to maintain code quality without addressing private member documentation.
GabeujinEnforce XML comment documentation standards for C# code.
Andreicr1Generate HTML, Markdown, and PDF API documentation from OpenAPI specs or code comments.
VoDaiLoczAutomate linting and static analysis of code in CI pipelines.
luisgustavooliveiraValidate XML comments and documentation adherence in C# code.
