关于 writing-no-comments
面向编码 Agent 的技能,规定新增或修改代码时避免添加注释,同时保留未改动行上的现有注释。它建议通过名称、类型、断言或测试表达意图。
主要功能
- 01避免在新增或修改代码中添加注释
- 02通过代码结构表达理由
- 03保留未改动行上的注释
- 04将规则交给编写代码的子 Agent
- 05按用户要求添加注释
适用场景
- 01编辑代码时减少注释
- 02指导编写代码的子 Agent
- 03检查差异中的注释变更
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ bostonaholic/ skills --skill writing-no-comments安装后在 Claude Code 中输入/writing-no-comments确认已加载。
附带文件agents/openai.yamlshared/code-comments.md
详细介绍
不写注释
- 除非代码注释规则允许,否则不要为你编写或编辑的代码添加注释。不确定时,就不要添加。
- 将原因写在名称、类型、断言或测试中。如果这些地方都无法承载,就写在提交消息或回复中。
- 测试和脚本不要添加步骤或阶段说明。
- 保留你未修改行上的注释。如果你的修改导致注释不再正确,请修正或删除该注释。
- 将这条规则告知为你编写代码的子 Agent,并在接受其更改前检查差异。
- 按用户要求添加注释。
评论
支持 Markdown