code-commenting

What problem does it solve?

This skill reduces noisy, redundant, and misleading comments by teaching when to avoid comments, when to explain rationale, and how to document public APIs so code remains readable and maintainable.

Core Features & Use Cases

• Decision framework for whether to comment, refactor, or rename to make code self-documenting.
• Examples and anti-patterns that show obvious, redundant, and outdated comments to avoid.
• Annotation tags and checklist for TODOs, FIXMEs, performance, security notes, and public API documentation suitable for code review and authoring workflows.

Quick Start

Apply the code-commenting guidelines to a function or module and rewrite comments to explain the reasoning and constraints rather than restating what the code does.