Write Comments

Write code comments the Ousterhout way AS you author or change code: comment only the non-obvious, write interface and header comments first, and let clear names carry the rest. Use while implementing a function, class or module, adding or editing a comment, writing a doc comment, JSDoc block or docstring, or deciding "should this have a comment, and what should it say". Triggers: "add a comment", "document this function", "write the header/docstring/JSDoc", "should I comment this", "comment this code". Do NOT use to audit comments that already exist (use `clean-comments`).

spencermarx Updated

File contents

spencermarx/skills commit e26cf518b6 Runs: spencermarx/setup-aclarify-skills

Frequently asked questions

npx get-skill add spencermarx/write-comments