comment-cleanup
CommunityKeep your code comments clean and concise.
Software Engineering#code quality#documentation#refactoring#clean code#readability#code comments#developer best practices
Authormotlin
Version1.0.0
Installs0
System Documentation
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.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: comment-cleanup Download link: https://github.com/motlin/claude-code-plugins/archive/main.zip#comment-cleanup Please download this .zip file, extract it, and install it in the .claude/skills/ directory.