Claude Code doc-catcher:发现 Go 注释与实际代码的矛盾
EnglishClaude Code 安装步骤
- 打开 GitHub 固定提交的 `.claude/skills/doc-catcher/SKILL.md`,核对内容与使用条件。
- 在自己的项目中创建 `.claude/skills/doc-catcher/`,把核对后的文件保存为 `.claude/skills/doc-catcher/SKILL.md`。
- 在该项目根目录启动 Claude Code,在斜杠菜单中选择 `/doc-catcher`。
中文摘要
读取 Go 包及调用关系,核实注释中的返回值、范围和所有权等约定是否与实现一致,给出按影响排序的报告。
SKILL.md 中文导读
可复现示例
包样例 docs-09 的注释说 UpperLimit 包含上界。Go 实际比较键是否小于上界。输入键 [2, 3, 4] 且上界为 4 时,遍历结果只有 [2, 3]。工作步骤
- 指定要审查的 Go 包,由理解代理读取实现和调用约定。
- 让文档审查代理核对直接证据,并按影响报告确认的注释矛盾。
验收方法
报告应引用这处注释和行为,说明 {documented: 'inclusive', actual: 'exclusive'}。按真实文件和行号定位,避免收录只有措辞差异的注释。
GitHub 原文 · 更新日期
适用环境
在 Claude Code 中打开 Pebble 仓库。保留 package-understander 与 doc-auditor 项目代理,提供仓库相对路径形式的 Go 包目录。
常见问题
如果注释写得短但与代码没有冲突,需要报告吗?
该流程关注可证实并会改变读者行为的差异。准确但简略的注释属于不同的文档维护任务。