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.

majiayu000 Updated 567 repo stars

File contents

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.

majiayu000/claude-skill-registry-data/tree/main/quality/comments-explain-why-omniaffix-dave-sessionguardian commit 3debb0b710

Frequently asked questions

npx skillmds@latest add majiayu000/comments-explain-why