Skip to content

code-clean-comments

Removes unnecessary comments from code while preserving essential documentation.

Synopsis

/code-clean-comments [scope] [base-branch]

/rp1-dev/code-clean-comments [scope] [base-branch]

Parameters

Parameter Default Description
scope branch Scope of files to clean
base-branch main Base branch for diff comparison

Scope Options:

  • branch - Files changed since diverging from base branch
  • unstaged - Only unstaged files (pre-commit use case)
  • <commit-range> - Any valid git commit range (e.g., HEAD~5..HEAD, abc123..def456)

Description

The code-clean-comments command systematically removes unnecessary comments from your codebase. It preserves docstrings, critical logic explanations, and required directives while removing redundant, outdated, or obvious comments.

What's Preserved

Type Example Status
Docstrings Function/class documentation ✓ Kept
Critical logic Complex algorithm explanation ✓ Kept
Type directives # type: ignore, // @ts-ignore ✓ Kept
License headers File copyright notices ✓ Kept
TODO with ticket // TODO(JIRA-123) ✓ Kept

What's Removed

Type Example Status
Obvious comments // increment counter ✗ Removed
Commented code // old_function() ✗ Removed
TODOs without tickets // TODO: fix later ✗ Removed
Progress markers // done ✗ Removed
Redundant docs Self-evident getter/setter docs ✗ Removed

Examples

Clean branch changes (default)

/code-clean-comments

Clean unstaged files only

/code-clean-comments unstaged

Clean specific commit range

/code-clean-comments HEAD~5..HEAD

Example output: 

✅ Comment Cleanup Complete

Files scanned: 45
Comments removed: 23
Comments preserved: 67

Changes:
- src/utils/helpers.ts: Removed 5 obvious comments
- src/api/routes.ts: Removed 3 commented code blocks
- src/models/user.ts: Removed 2 redundant docstrings

Note: Run code-check to verify no issues introduced