What problem does it solve?
Manually writing XML documentation for C# code is time-consuming and often overlooked, leading to poorly documented APIs. This skill intelligently generates accurate XML documentation comments based on method signatures, naming conventions, and code structure, ensuring your public APIs are always clear and discoverable.
Core Features & Use Cases
- Semantic Inference: Generates
<summary>, <param>, and <returns> tags by understanding the purpose of methods, properties, and parameters.
- Cross-Reference Support: Creates accurate
<see cref="..."/> tags for linked types, enhancing navigation.
- Non-Destructive: Preserves existing documentation while adding comments to undocumented members.
- Use Case: You've just finished a new public API and need to generate comprehensive XML documentation for IntelliSense and external consumers. Use
doc-generator to automatically add well-structured comments to all public members of your ProductService class.
Quick Start
Use the doc-generator skill to add XML documentation comments to the "ProductService" class in "MyNamespace.ProductService".
