clean-comments

What problem does it solve?

Codebases often accumulate redundant, obvious, or outdated comments that add noise rather than value, making code harder to read, understand, and maintain. This skill automates the removal of such comments while meticulously preserving only the critical explanations, enhancing code clarity and developer focus.

Core Features & Use Cases

• Obvious Comment Removal: Automatically deletes comments that merely restate what the code clearly does (e.g., // increment counter above counter++), reducing visual clutter.
• Valuable Explanation Preservation: Intelligently identifies and keeps comments that explain complex algorithms, non-obvious implementations, business logic, or architectural decisions, ensuring crucial context is never lost.
• Comment Simplification: Reduces verbose comment blocks to concise, meaningful lines, focusing on the "why" behind the code rather than a literal description of its "what."
• Use Case: Before a code review or a major commit, run this skill on a newly developed module. It will strip away comments like # Loop through items and keep only the crucial ones, such as # IMPORTANT: Must validate before save to prevent orphaned records, ensuring reviewers focus on the code's intent and not redundant text.

Quick Start

Before:

Increment the counter

counter += 1

After:

counter += 1

Before:

This function calculates the total price by iterating through

all items in the cart, multiplying each item's quantity by its

price, and then summing all the results together to get the final total.

def calculate_total(cart):

return sum(item.quantity * item.price for item in cart)

After:

Includes bulk discount calculation for quantities >10

def calculate_total(cart):

return sum(item.quantity * item.price for item in cart)