AGENT SKILL

code-comments

Use while implementing or reviewing edge cases, failure paths, or unexpected behavior to document the non-obvious constraints in code. Also use when asked to add or improve code comments.

适用职业开发工程师
License 许可
MIT
最近更新
2026-11-06
Stars
★ 1.5k
Forks
99

01 前言 Front Matter

name
code-comments
metadata
{ "internal": true }
description
Use while implementing or reviewing edge cases, failure paths, or unexpected behavior to document the non-obvious constraints in code. Also use when asked to add or improve code comments.

03 SKILL.md 正文

Code comments

When implementing edge cases, failure paths, or unexpected behavior, always document why that code was written.

  • Use the codebase's terms in plain English.
  • Skip comments when a clear name or small code change makes the behavior obvious.
  • Do not restate conditions, narrate the PR or conversation, or describe behavior that has not been verified.

04 同仓库更多 Skills