dotnet-docfx

What problem does it solve?

This Skill helps ensure that .NET/C# class types have complete and well-formed XML doc-comment coverage, including for private members and nested types, improving documentation quality and code readability.

Core Features & Use Cases

• Audit XML Doc-Comments: Checks types, fields, properties, methods, and events for missing or incomplete XML comments.
• Generate Missing Comments: Creates missing XML comments based on the code, filling in descriptions, parameters, and exceptions.
• DocFX Integration: Optionally generates a documentation report using DocFX to validate the formatting and completeness of doc comments.
• Use Case: When working on a .NET project and you want to ensure that all public and private types and members have proper documentation.

Quick Start

To audit and fill doc comments for all classes in the current project, use: /dotnet-docfx