comment-cleanup
Installation
SKILL.md
Comment Cleanup
Analyze and improve documentation in the specified file following the Comment Standards defined in the code-quality skill.
Target File
$ARGUMENTS
Analysis Process
- Read the file to understand its purpose and structure
- Identify naming improvements that could make code more self-documenting
- Find complex logic that needs explanation
- Locate design decisions that should be documented
- Remove harmful comments that add noise or are outdated
- Add strategic comments where they reduce cognitive load
Execution
- Read and analyze the target file
- Suggest and apply naming improvements if needed
- Remove redundant or misleading comments
- Add comments only where they:
- Explain non-obvious behavior
- Document design decisions
- Clarify complex algorithms
- Provide essential interface documentation
- Leave code cleaner than found