AgentSkillsCN

comment-review-criteria

源代码注释评审标准。明确注释应重点阐释的内容,并对设计思路、LLM 跟踪记录,以及冗余注释等违规行为进行标记与提醒。

SKILL.md
--- frontmatter
name: comment-review-criteria
description: "Source code comment review criteria. Defines what comments should explain and flags violations like design rationale, LLM traces, and redundant comments."
user-invocable: false

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