comment-review

Community

Clarify WHY in code comments, not WHAT

Authorlattenwald
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill validates code comments against best practices, ensuring comments add value by explaining rationale rather than restating obvious code.

Core Features & Use Cases

  • Good Comments (WHY): Identifies comments that explain decisions, constraints, and context instead of restating code.
  • Noise Removal: Flags comments that merely restate obvious actions and should be removed.
  • Public API Rationale: Suggests documenting API behavior and expectations with reasoning.
  • Output & Guidance: Provides actionable recommendations and concrete examples to improve comment quality.

Quick Start

Ask Claude to review the comments in a code file (e.g., main.go) and evaluate whether each comment explains WHY, cites context, and avoids repetition. Request a prioritized report with suggested rewrites.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: comment-review
Download link: https://github.com/lattenwald/my-home-manager/archive/main.zip#comment-review

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.