code-comment-improver

What problem does it solve?

This Skill addresses the challenge of unclear, missing, or outdated code comments, making codebases harder to understand and maintain.

Core Features & Use Cases

• Improve Code Comments: Transform vague or absent comments into clear explanations.
• Add Documentation: Generate comprehensive documentation for functions, modules, and classes.
• Review Comment Quality: Ensure comments explain the "why" and not just the "what".
• Use Case: You've inherited a complex function with minimal comments. Use this Skill to generate detailed JSDoc comments explaining its parameters, return values, and the reasoning behind its logic.

Quick Start

Use the code-comment-improver skill to improve the comments in the provided code snippet.