Agent skill
comments-explain-why
Good comments explain: business rules ("Tax is calculated differently for EU customers due to VAT... Use when documenting code and APIs. Documentation category skill.
Install this agent skill to your Project
npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/other/other/comments-explain-why
Metadata
Additional technical details for this skill
- category
- Documentation
- priority
- high
- is built in
- YES
- session guardian id
- builtin_comments_explain_why
SKILL.md
Comments Explain Why
Good comments explain: business rules ("Tax is calculated differently for EU customers due to VAT regulations"), workarounds ("Using setTimeout because the library has a race condition - see issue #123"), non-obvious decisions ("We use insertion sort here because n is always small and it's faster for nearly-sorted data"). Don't comment what is obvious from the code itself.
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
majiayu000/claude-skill-registry
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
majiayu000/claude-skill-registry
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
majiayu000/claude-skill-registry
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
majiayu000/claude-skill-registry
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
majiayu000/claude-skill-registry
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
majiayu000/claude-skill-registry
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
Didn't find tool you were looking for?