Documentation
README
Code Comment Generator
Generate meaningful, maintainable comments and documentation for your code.
Core Capabilities
This skill helps you create effective code documentation by:
- Analyzing code context - Understanding what the code does and why
- Matching existing style - Following comment conventions in your codebase
- Writing clear documentation - Creating function/method/class documentation
- Adding inline explanations - Explaining complex logic and algorithms
- Inserting code annotations - Adding TODO, FIXME, and optimization notes
Comment Generation Workflow
Step 1: Analyze Existing Comment Style
Before generating comments, examine the codebase to match style:
This is the opening of the README. Read the full README on GitHub.