Document C# types with XML comments for .NET libraries and APIs.
npx skills add https://github.com/mkazimoto/AppMAUICopilot --skill csharp-docs-mkazimoto
Please help me install this Agent Skill. Skill: csharp-docs Source: https://github.com/mkazimoto/AppMAUICopilot/tree/main/.github/skills/csharp-docs Command: npx skills add https://github.com/mkazimoto/AppMAUICopilot --skill csharp-docs-mkazimoto
C# codebases often lack consistent XML documentation, making APIs hard to discover and hard to reason about. This Skill provides a structured approach to documenting public and internal members using XML comments, with guidance to maintain clarity and consistency across projects.
Add XML documentation comments to a sample class and generate an API reference document with your preferred tool.
High-intent search queries and answers about installing and using this skill.
To add XML comments to C# public members, insert tags like <summary>, <param>, and <returns> directly above classes, methods, and properties. This XML documentation improves API clarity and maintainability by ensuring consistent documentation across public surfaces in .NET libraries.
For comprehensive C# API docs, use <summary> for brief descriptions, <remarks> for details, <param> and <returns> for method signatures, <see cref> for cross-references, <example> for code samples, and <inheritdoc> to inherit base member documentation.
XML documentation in .NET is enforced on public members to ensure API discoverability, while offering recommended practices for internal members. This approach maintains consistency across projects without imposing strict requirements on every internal type.
The best way to generate API reference docs from C# XML comments is to apply structured XML tags across public surfaces and use your preferred documentation generation tool. Consistent <summary> and <see cref> usage ensures accurate reference output for .NET libraries.
Use the <inheritdoc> tag in C# XML documentation when implementing interfaces or overriding base class members to automatically inherit their XML comments. This prevents duplicate documentation and maintains consistency across inherited public APIs.
C# codebases lack consistent API documentation when there are no structured guidelines for XML comments. Applying standardized practices for <summary>, <remarks>, and <see cref> tags across public and internal members ensures maintainability and improves API discoverability.
kierunbDocument public C# types with XML comments and enforce XML tag usage.
AGIBuildGenerate .NET API documentation with DocFX and OpenAPI specifications.
The-Standard-OrganizationEnforce The Standard's C# coding conventions across projects.
openyakRead, create, and edit DOCX documents locally using Python-docx and XML.
