What problem does it solve?
Excessive, outdated, or poorly formatted comments clutter code, making it harder to read, understand, and maintain. This Skill helps you eliminate comment debt and ensure comments add genuine value.
Core Features & Use Cases
- Minimalist Commenting: Advocates for using comments sparingly and removing commented-out code entirely.
- Action-Oriented Comments: Prohibits comments that describe the process of changing code (e.g., "added," "removed") or emphasize different code versions.
- Structured Placement: Enforces placing comments above the code they describe, avoiding end-of-line comments for better readability.
- Use Case: When adding, editing, or removing comments, use this skill to automatically identify and refactor comments that violate best practices, ensuring your codebase remains clean, readable, and free of unnecessary noise.
Quick Start
Review the comments in data-processor.js and remove any unnecessary or poorly formatted ones.