code-comment-writer
OfficialAdd intent-focused comments for clearer code
System Documentation
What problem does it solve?
Developers often inherit code that is hard to understand because comments state what the code does rather than why it exists, leaving intent, edge cases, pitfalls, and migration context unclear; this Skill produces concise, reader-oriented comments that explain rationale and decision intent so future maintainers can act confidently.
Core Features & Use Cases
- Write intent comments that explain why a block exists, the tradeoffs made, and any historical or migration context.
- Document edge cases, known boundaries, and surprising behaviors to prevent regressions and onboarding friction.
- Mark technical debt and actionable items with TODO/FIXME/DEPRECATED markers and reference tickets when available.
- Include ASCII diagram guidance for complex control flows or component layouts using the references/diagram-guide when needed.
- Ideal for onboarding new engineers, preparing code for refactoring, documenting algorithm choices, and clarifying API integration quirks.
Quick Start
Annotate the following code with intent-focused comments explaining why each part exists, call out edge cases and pitfalls, and add TODO/FIXME markers or migration notes where appropriate.
Dependency Matrix
Required Modules
None requiredComponents
💻 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: code-comment-writer Download link: https://github.com/ImaginerLabs/skill-manager/archive/main.zip#code-comment-writer Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.