01
这个 skill 做什么
当文件需要围绕意图、约束、数据含义、公共契约或非显然控制流留下持久注释时使用此 skill。它会先读取本地注释风格,必要时移除薄弱或重复的注释,只添加能帮助后续读者推理代码的注释。
02
什么时候使用
- 信号为导出的函数、接口、类、类型和配置对象补充文档。
- 信号用经得起实现变化的说明替换过时或只复述语法的注释。
- 信号澄清字段、选项、状态变体,以及属于契约一部分的分支含义。
03
如何工作
- 01
编辑前先阅读顶层定义,让注释匹配文件真实的所有权边界。
- 02
识别附近注释的语言、语气、密度和格式约定。
- 03
按读者价值排序候选注释,并选择最小但有用的粒度。
- 04
在添加新注释前改写或移除低价值注释,保持一致的文档声音。
- 05
复读最终文件,确认每条注释在小的实现细节变化后仍然成立。
04
你会得到什么
- 信号默认只提交针对注释的补丁,除非用户明确要求更广的代码修改。
- 信号解释分支为何存在、字段意味着什么,或哪里容易误用的注释。
- 信号包含所请求验证结果的简洁完成说明。
05
重要边界
- 信号不要添加只是复述语法的叙述。
- 信号除非当前请求明确要求,不要 stage、commit 或推进 Git 状态。
- 信号匹配仓库现有注释风格,而不是强行引入新的文档体系。
06