code-comment-generator

What problem does it solve?

This Skill addresses the challenge of maintaining well-documented codebases, which is crucial for team collaboration, onboarding new developers, and long-term project maintainability. It automates the generation of meaningful comments and documentation.

Core Features & Use Cases

• Automated Documentation: Generates docstrings for functions, methods, and classes in Python and Java.
• Inline Explanations: Adds comments to complex logic, algorithms, and non-obvious code sections.
• Code Annotations: Inserts standard markers like TODO, FIXME, HACK, OPTIMIZE, NOTE, and DEPRECATED.
• Style Adherence: Analyzes existing comment styles to ensure consistency within a codebase.
• Use Case: A developer has just finished implementing a complex algorithm in Python. They can use this Skill to automatically generate a comprehensive docstring explaining the algorithm's purpose, parameters, return values, and any edge cases, significantly speeding up the documentation process.

Quick Start

Use the code-comment-generator skill to add documentation to the provided Python function.