mcpField
R
remove-dumb-comments

remove-dumb-comments

github.com/lukeberrypi开发25244 次安装11 周前更新
代码仓库

关于 remove-dumb-comments

remove-dumb-comments 是一项代码审查技能，用于找出重复描述代码的注释，同时保留解释意图或背景的注释。它会排列候选项，并在删除前征求确认。

主要功能

  1. 01按价值排序冗余注释
  2. 02用 git blame 检查注释时间
  3. 03保留解释原因的注释
  4. 04编辑前征求确认
  5. 05编辑后运行 lint 和类型检查

适用场景

  1. 01审查源代码中的注释
  2. 02清理仅复述代码的注释

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/lukeberrypi/skills --skill remove-dumb-comments

安装后在 Claude Code 中输入/remove-dumb-comments确认已加载。

详细介绍

删除无意义注释

标记那些只是复述代码本身含义的注释；保留所有解释为什么的注释。由用户选择要删除哪些被标记的注释。

调用方式

命令行为
/remove-dumb-comments找出价值最低的 10 条注释。
/remove-dumb-comments <number>找出指定数量的价值最低的注释。
/remove-dumb-comments all找出所有低价值注释。

绝不删除

保留任何承载代码无法传达的为什么的注释：

  • 向后移植、兼容性或特定版本的行为；
  • 基础设施、部署或架构；
  • 变通方案、陷阱或非显而易见的原因；
  • 文档、规范、RFC 或 ADR；
  • bug、issue、工单或带上下文的 TODO/FIXME；
  • 意图、取舍或约束。

拿不准时，保留。只标记纯粹的复述。

工作流

  1. 根据调用方式确定数量上限（默认 10）。
  2. 搜索源文件；跳过生成产物、供应商依赖、锁文件和文档。
  3. 将候选注释从最冗余到最不冗余排序。
  4. 用 git blame 获取每条候选注释的年龄（见注释年龄）。
  5. 展示下方表格，然后询问是否删除所有推荐项（见反馈）。
  6. 若同意，将每个 Remove 项视为已批准。若不同意，对每条逐一询问 Remove 或 Keep，以其确切文本而非位置来指代。
  7. 仅删除已批准的注释。
  8. 运行项目的 lint 和类型检查；修复因改动导致的任何问题。

若有可用的快速、低推理 subagent，将只读搜索委派给它：最多请求上限数量，每条包含确切路径、行号、注释文本以及一到三行相邻代码。否则直接搜索。

注释年龄

对每条候选注释，运行：

git blame -L <line>,<line> --date=relative -- <file>

使用相对日期；将未提交的行标记为 uncommitted。

必需输出

严格使用以下列：

| Comment | Age | Why |
|---------|-----|-----|
| `// increment the counter` | 8 months ago | *Remove.* Restates `count++` verbatim. |
| `/** Returns the user id. */` | 3 weeks ago | *Remove.* Describes the function word by word. |
| `// debounce avoids hammering the API on each keypress` | 1 year ago | *Keep.* Explains intent, not mechanics. |
  • Comment：用反引号包含确切的注释文本。
  • Age：使用 git blame 的相对年龄。
  • Why：以 *Remove.* 或 *Keep.* 开头，然后给出一条简短理由。

反馈

展示表格后，询问：

删除所有推荐项？

  • 是，删除所有推荐项
  • 否，我想逐条审查

评论

支持 Markdown