clean-comments
Streamline your codebase by automatically removing redundant or obvious comments while preserving essential architectural and logic-focused documentation.
Introduction
This skill acts as an intelligent cleaner for your source code, designed to improve maintainability by pruning noise from your files. In modern software development, excessive or redundant comments can distract developers from the actual logic and often become stale. This tool enforces a 'code-as-documentation' philosophy, ensuring that comments serve to clarify complex business logic, edge cases, or non-obvious architectural decisions rather than restating simple syntax like incrementing a variable or basic looping mechanisms.
The tool is particularly useful for engineers preparing code for pull requests, conducting team code reviews, or performing repository refactoring. By analyzing the intent behind your comments, it selectively removes obvious descriptions while rigorously protecting valuable context, such as performance justifications, bug report references (e.g., issue #1234), or critical migration warnings. It encourages developers to write cleaner, more self-descriptive code, ultimately reducing the cognitive load on anyone reading the repository.
-
Automatically identifies and removes redundant inline comments that restate code execution.
-
Preserves high-value context including decision points, complex algorithm details, and non-obvious implementations.
-
Consolidates verbose documentation blocks into concise, one-line explanations focused on 'why' instead of 'what'.
-
Filters out obsolete TODOs or FIXME comments that refer to already completed tasks.
-
Supports batch processing of up to 15 files per session to ensure manageable, predictable review cycles.
-
Best used during the pre-review phase to ensure that reviewers focus on the logic rather than documentation noise.
-
Trust that readable code is the primary documentation; only add comments when the code's purpose cannot be inferred by a new developer.
-
When simplifying, prioritize explaining business logic or architectural constraints rather than variable naming conventions.
-
The tool is designed to work seamlessly with modern repository structures, including TypeScript, Python, and other common languages found in complex monorepo environments.
-
Constraints: The process is strictly additive to clarity; always review the tool's suggestions to ensure that critical team-specific documentation is not inadvertently stripped.
Repository Stats
- Stars
- 12
- Forks
- 2
- Open Issues
- 1
- Language
- Python
- Default Branch
- main
- Sync Status
- Idle
- Last Synced
- May 3, 2026, 02:19 AM