code-comments

SKILL.md

Write documentation that lives with the code it describes. Plain language. No jargon. Explain the why, not the what.

Co-location wins. Documentation in separate files drifts out of sync. Comments next to code stay accurate because they're updated together.

The "why" test: Before writing a comment, ask: "Does this explain why this code exists or why it works this way?" If it only restates what the code does, skip it.

编写清晰、通俗易懂的代码注释和与代码一起存在的文档。在编写或审查需要内联文档（文件头、函数文档、架构决策或解释性注释）的代码时使用。针对人类读者和人工智能编码助理进行了优化，他们可以从同一位置的上下文中受益。 来源：petekp/claude-code-setup。

查看原文