comment-cleanup

Analyze source files and rewrite comments to clarify intent and remove redundancy.

62|2|Updated Feb 21, 2017
One-click install
npx skills add https://github.com/ahonn/dotfiles --skill comment-cleanup-ahonn
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: comment-cleanup
Source: https://github.com/ahonn/dotfiles/tree/main/.claude/skills/comment-cleanup
Command: npx skills add https://github.com/ahonn/dotfiles --skill comment-cleanup-ahonn

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Clean up and clarify code comments to improve readability and maintainability by removing redundancy and documenting design decisions where needed.

Core Features & Use Cases

  • Identify and remove redundant or outdated comments while preserving essential explanations.
  • Improve comment quality by enhancing naming, documenting WHY decisions were made, and clarifying non-obvious behavior.
  • Apply consistent commentary practices across functions, modules, and interfaces to reduce cognitive load for future maintainers.

Quick Start

Analyze the target file path and refine inline documentation with essential clarifications, without changing code behavior.

Frequently Asked Questions about comment-cleanup

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I clean up and clarify code comments automatically?

To clean up code comments automatically, this Skill analyzes source files and rewrites documentation to enhance readability and intent. It removes redundant explanations and clarifies non-obvious behavior while preserving all original code structure and behavior.

What is the best way to remove redundant comments without changing code behavior?

The best way to remove redundant comments non-destructively is to use an automated refactoring tool that preserves code behavior. This Skill edits inline documentation and clarifies design decisions without altering the underlying source structure.

Can I improve code documentation across different modules and functions?

Yes, you can improve code documentation across modules and functions by applying consistent commentary practices. This Skill analyzes classes and modules to document design decisions and reduce cognitive load for future maintainers.

Does automated comment cleanup respect existing project style conventions?

Automated comment cleanup respects project guidelines and style conventions by design. This Skill analyzes your source files and refines inline documentation to match existing practices without introducing conflicting formatting.

When do I need to refactor code comments for better readability?

You need to refactor code comments for better readability when outdated or unclear documentation increases maintenance cognitive load. This Skill identifies missing context in functions and rewrites explanations to clarify the reasoning behind design decisions.