关于 clean-comments
clean-comments 是面向开发者的代码注释规范，强调注释应补充技术信息，而非重复代码。它说明如何清理过时、冗余或被注释掉的代码。
主要功能
- 01注释中不记录元数据
- 02删除过时注释
- 03避免重复代码内容
- 04撰写简洁清晰的技术说明
- 05删除被注释掉的代码
适用场景
- 01整理代码时审查注释
- 02将代码行为说明改为原因说明
- 03代码变更后清除过时备注
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/clean-comments确认已加载。
详细介绍
整洁的注释
C1：不包含不适当的信息
注释不应包含元数据。作者姓名、变更历史、工单编号和日期应交由 Git 记录。注释只用于说明代码的技术细节。
C2：删除过时的注释
如果注释描述的代码已不存在或行为已改变，请立即删除。过时的注释会变成“无关且误导人的孤岛”。
C3：不要写冗余注释
// Bad - the code already says this
i += 1; // increment i
user.save(); // save the user
// Good - explains WHY, not WHAT
i += 1; // compensate for zero-indexing in display
C4：写好注释
如果值得写注释，就要把它写好：
- 谨慎措辞
- 语法正确
- 不要啰嗦，也不要陈述显而易见的内容
- 简明扼要
C5：绝不提交已注释掉的代码
// DELETE THIS - it's an abomination
// function oldCalculateTax(income: number): number {
// return income * 0.15;
// }
谁知道它有多老？谁知道它还有没有意义？删掉它。 Git 会记住一切。
目标
最好的注释就是代码本身。如果需要注释来解释代码的作用，请先重构，最后再写注释。
评论
支持 Markdown