Document public C# types with XML comments and enforce XML tag usage.
npx skills add https://github.com/kierunb/ReliableAppDemo --skill csharp-docs-kierunb
Please help me install this Agent Skill. Skill: csharp-docs Source: https://github.com/kierunb/ReliableAppDemo/tree/main/.github/skills/csharp-docs Command: npx skills add https://github.com/kierunb/ReliableAppDemo --skill csharp-docs-kierunb
This Skill ensures that C# types are documented with XML comments and follow best practices for documentation.
Annotate a sample public class with XML comments and apply the summary and remarks guidelines to generate consistent API documentation.
High-intent search queries and answers about installing and using this skill.
To generate consistent C# XML documentation, apply standardized XML comments to public types, methods, and properties using summary, remarks, see, and code example tags to enforce consistent API documentation across projects.
The best way to document C# methods and parameters is using XML comments with summary, remarks, and code example tags. This provides templates and guidelines to maintain consistency across types, methods, and parameters.
You need XML comments in C# code when you want to generate standardized API docs for consumer projects. Documenting all public C# types ensures consistent API documentation and best practices for teams migrating .NET libraries.
This XML documentation approach provides guidance for both public members and internal members. It applies guidelines to methods, properties, parameters, and type members to maintain consistency across the entire codebase.
You should use the summary, remarks, see, and code example XML tags for C# code documentation. Enforcing this specific tag usage ensures standardized docs are generated from the codebase with consistent API references.
afonsoftEnforce XML documentation comments on public C# types and members.
theodrosyimerGenerate a browsable API documentation website from an OpenAPI specification.
leonanpereirapintoEnforce XML comments on public C# types and members.
AGIBuildGenerate .NET API documentation with DocFX and OpenAPI specifications.
