Document C# public types and members with XML comments.
npx skills add https://github.com/iliasjennane/LearningAgent --skill csharp-docs-iliasjennane
Please help me install this Agent Skill. Skill: csharp-docs Source: https://github.com/iliasjennane/LearningAgent/tree/main/.agents/skills/csharp-docs Command: npx skills add https://github.com/iliasjennane/LearningAgent --skill csharp-docs-iliasjennane
C# types often lack consistent XML documentation, making APIs harder to discover and maintain. This skill enforces XML comment usage and standard documentation practices to improve code understandability.
Document a sample public class by adding XML comments for Summary, Remarks, See, and Example according to the guidelines.
High-intent search queries and answers about installing and using this skill.
To document C# public methods with XML comments, add standard tags like <summary>, <param>, and <returns> directly above your method signatures. This ensures your API is discoverable and maintainable for library consumers.
C# API documentation should use <summary>, <remarks>, <param>, <returns>, <exception>, <see>, and <example> tags. These tags provide structured guidance on public types, methods, properties, and constructors to improve code understandability.
Add <exception> and <example> tags above C# constructors to document thrown exceptions and demonstrate usage. Applying these XML comments to public constructors ensures your library API exposes well-documented real-world scenarios.
Documenting C# properties with XML comments improves API discoverability by enforcing consistent documentation practices across public members. This standardizes code understandability for teammates and SDK consumers.
The best way to enforce coding standards for C# XML documentation is to apply guidelines requiring <summary> and <remarks> tags on all public types, methods, and properties. This solves inconsistent API documentation in libraries.
You need XML comments in C# library development when exposing public APIs, types, and constructors to consumers. Applying documentation best practices ensures your SDK remains maintainable and easily discoverable by teammates.
FabienDehopreGenerates standardized XML comments and API documentation for C# code.
plastikawebGenerate Markdown documentation, API references, and architecture guides from codebases.
derekhu0002Enforce modern C++ Core Guidelines for RAII, type safety, and explicit interfaces.
leonanpereirapintoEnforce XML comments on public C# types and members.
