用途:为代码添加或补强注释与文档注释,不修改实现逻辑,目的是让职责边界、调用方前提、返回值契约及与其他模块的依赖关系“就地可读”。触发语包括“添加注释”“补强注释”“加 JSDoc”“加 docstring”等。
主要能力:按语言惯例生成文档注释(TypeScript/JavaScript 用 JSDoc,Python 用 docstring,Rust 用 /// 与 //!,Go 用 // FuncName 形式,Java/Kotlin 用 Javadoc);补充说明 why 的行内注释;检查并修正与实现脱节的既有注释;执行安全自查,避免在注释中写入密钥、令牌、密码或个人信息。
使用方式:comment-code <目标文件或目录> [--lang <语言>]。省略参数时以 git diff HEAD 的差异文件为对象,可用 git diff HEAD --name-only 列出,未跟踪文件用 git ls-files --others --exclude-standard 列出。--lang 指定文档注释格式,未指定则按扩展名自动判断。前提是文件可读且位于 Git 仓库内。
流程:先确定目标文件;再从代码库调查其角色,包括用 grep 搜索调用方、查看 import 与依赖、确认包与服务边界、了解既有注释风格;然后写入注释;接着做正确性与安全自查;最后以 git diff HEAD 展示差异并输出报告。
适用场景:为新增或修改的代码补充上下文注释,为公开接口补全文档注释,修正过时注释。
限制:不改变代码逻辑,若发现实现问题会引导至 implement-issue 技能;不执行提交,提交交由 create-commit 技能;仓库内存在 .claude/rules/code-comment-style.md 时以其规约优先;禁止使用 --no-verify 等方式绕过 pre-commit 钩子。其他细节暂未提供。