Comment Review Criteria

Source code comment review criteria. Defines what comments should explain and flags violations like design rationale, LLM traces, and redundant comments. Use when this capability is needed.

tomevault-io Updated

File contents

Comment Review Criteria

Source code comments should explain constraints affecting correctness, not design rationale.

Flag as violations:

  • Design rationale (why this API/format/protocol was chosen)
  • LLM generation traces (AI/Claude mentions, "Generated by" markers)
  • Implementation history (belongs in commit messages)
  • Conversational tone
  • Redundant comments duplicating code

Converted and distributed by TomeVault — claim your Tome and manage your conversions.

tomevault-io/skills-registry/tree/main/sato-dev1234--claude-code-sample--comment-review-criteria commit cfaeda5cd4

Frequently asked questions

npx skillmds@latest add tomevault-io/comment-review-criteria