搜索你想找的开源项目

输入名称、用途或关键词,也可粘贴 GitHub 仓库链接
全部技能

writing-code-comments

判断一条代码注释是否该存在,并把保留的注释改写成解释原因。

适合什么时候用

你正准备在改动里加注释,或在审阅带注释的 diff,需要区分有用的原因说明和复述代码、变更历史、过时数字。

举个例子

你对 AI 说

用 writing-code-comments 处理这个 diff:我在 `retries += 1` 上方加了 `# increment retry count`,在退避函数上加了 `# per PR #1234`,在 CI 超时上加了 `# ~20 min build`。清理这些注释。

你会拿到
  • 删除或改写注释
  • 保留的原因注释清单

它会怎么做

  • 默认不写注释;注释必须告诉未来的读者代码本身表达不了的信息。
  • 易过时的数字要换成它所代表的长期事实,除非带日期或与代码字面量绑定。