Enforce XML documentation comments on public and internal C# members.
npx skills add https://github.com/74nu5/Narratum --skill csharp-docs
Please help me install this Agent Skill. Skill: csharp-docs Source: https://github.com/74nu5/Narratum/tree/main/.github/skills/csharp-docs Command: npx skills add https://github.com/74nu5/Narratum --skill csharp-docs
This Skill ensures that C# code is well-documented using XML comments, improving code readability, maintainability, and enabling automatic documentation generation.
<summary>, <remarks>, <param>, etc.).Ensure all public members in the C# project are documented with XML comments.
High-intent search queries and answers about installing and using this skill.
To document C# code using XML comments, apply standard tags like `<summary>`, `<param>`, and `<remarks>` to public and internal members. This practice provides comprehensive API documentation, enabling automatic generation of readable reference files and IntelliSense support.
Enforcing XML documentation standards for a C# library involves systematically applying Microsoft's best practices to all public APIs. Ensure every parameter, return value, exception, and type parameter is documented to improve overall code maintainability and discoverability.
Yes, you need XML comments for internal members in C# to ensure comprehensive API documentation. Documenting internal members alongside public ones improves code discoverability and helps developers understand how to correctly use classes, methods, and properties.
Adding XML comments improves C# code maintainability by making it easier for other developers and your future self to understand the codebase. Standardized documentation tags generate automatic IntelliSense support, clarifying how to use classes, methods, and properties effectively.
For C# API documentation, you should use standard XML tags such as `<summary>`, `<remarks>`, `<param>`, and `<returns>`. These tags document parameters, return values, exceptions, and type parameters, ensuring comprehensive coverage and enabling automatic documentation generation.
lluppesmsEnforce XML documentation standards for public and internal C# members.
JXISHDevelop a C# driver for JYTEK JY5113 DAQ cards via PCIe or PXIe interfaces.
GabeujinEnforce XML comment documentation standards for C# code.
arash77Automate linting, formatting, and type checking for Python and client-side codebases.