Enforce XML documentation standards for public and internal C# members.
npx skills add https://github.com/lluppesms/dadabase.demo --skill csharp-docs-lluppesms
Please help me install this Agent Skill. Skill: csharp-docs Source: https://github.com/lluppesms/dadabase.demo/tree/main/.github/skills/csharp-docs Command: npx skills add https://github.com/lluppesms/dadabase.demo --skill csharp-docs-lluppesms
This Skill helps maintain high code quality by ensuring that C# code adheres to XML documentation best practices, making it easier to understand and use.
Use the csharp-docs skill to check the documentation of the C# code in the current directory.
High-intent search queries and answers about installing and using this skill.
XML documentation standards for C# code are enforced by verifying that public and internal members include required tags like <summary> and <param>. This ensures comprehensive API documentation and prevents technical debt.
For comprehensive C# API documentation, you should use standard XML comment tags including <summary>, <remarks>, <param>, <returns>, and <exception>. These tags provide detailed guidance for documenting parameters, return values, and exceptions.
Yes, you can integrate C# documentation checks into a CI pipeline to automatically flag new or modified code lacking proper XML documentation. This prevents technical debt by ensuring all public and internal members are documented.
C# code documentation matters because adhering to XML documentation best practices makes codebases easier to understand and use. Proper documentation of summaries, parameters, and exceptions facilitates long-term maintainability and high code quality.
The best way to document C# exceptions and return values is by using the <exception> and <returns> XML comment tags. These tags provide explicit guidance on method behaviors, ensuring the API documentation is comprehensive.
markarnoldutahEnforce XML documentation standards for public and internal C# members.
theodrosyimerGenerate a browsable API documentation website from an OpenAPI specification.
kleon6436Enforce C# coding standards for naming, formatting, and XML documentation.
darylmcdGenerate XML doc comments for undocumented public C# APIs using Roslyn analysis.
