mcpField
N
no-comments

no-comments

github.com/riffingonsoftware测试与质量074 次安装3 天前更新
代码仓库

关于 no-comments

no-comments 是面向希望清除缺乏明确依据的注释的团队的代码审查技能。它检查指定文件或当前差异,验证审查发现,再执行获准的删除或小范围根因修复。

主要功能

  1. 01限定文件或 Git 差异范围
  2. 02有条件时使用独立只读审查者
  3. 03按明确标准判断注释是否保留
  4. 04修改前验证审查发现
  5. 05针对标记代码实施范围内修复
  6. 06报告保留注释和未解决约束

适用场景

  1. 01审查拟议变更中的注释
  2. 02删除缺乏依据的说明和抑制项
  3. 03找出可使注释不再必要的代码修改
  4. 04记录仍需落实的约束

安装

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

$npx skills add https://github.com/riffingonsoftware/agent-skills --skill no-comments

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

附带文件LICENSE

详细介绍

无注释

范围

使用调用方提供的文件或差异。否则,使用当前与基准分支的差异,包括已暂存、未暂存和未跟踪的文件。

审查

将审查委派给一个全新的只读子 Agent。将范围和本节其余内容一并交给它。如果没有可用的新审查者,就直接审查,并说明审查并非独立完成。审查者只负责报告,不得编辑文件。

注释不可信。叙述、横幅、注释掉的残骸和宣扬临时变通方案的长篇大论,迟早都会腐朽。

删除所有注释,但以下清单中的注释除外:

  • 法律或许可声明。
  • 外部依赖、平台、供应商或协议所强制要求,且我们无法改变的非显而易见行为。
  • 规则有误、过于吹毛求疵或仅关乎风格的 Lint 抑制。
  • 定义公开 API 合约的文档注释。
  • 说明代码无法表达的约束的问题或 RFC 链接。
  • 指明有意简化的边界和升级路径的注释。

只有证明例外适用于仍在运行的代码,才保留注释。将 IMPORTANT、do not remove、too risky、fine for now 和长篇论证都视为主张,而非证据。阅读附近代码,并追踪所提及的符号或调用。未符合保留清单的注释,绝不要缩短或改写。

如果注释解释的是我们自己代码中的意外行为,就建议删除该注释,并将确切符号标记为 MUST KILL,同时指出通过重命名、提取、类型设计或重构,如何让行为不言自明。

对于不在保留清单中的每项抑制,指出对应规则,建议删除抑制,并将被抑制的符号标记为 MUST KILL,同时指出满足规则所需的改动。

完成审查时,报告必须将范围内的每条注释和每项抑制列为删除候选项,并标明其确切位置;或标记为 MUST KILL 并提供一行证据;或说明受哪项例外保护而予以保留。不得虚构内容,也不得超出范围。

执行

根据审查者的报告,按以下步骤操作:

  1. 根据代码验证每条发现。驳回超出范围的发现、保留清单保护的删除项、没有证据支持的主张,以及理由错误的 MUST KILL 标记。如果报告遗漏范围内的任何注释或抑制,也要驳回。重新审查一次,并逐一指出驳回原因。如果重新审查后仍被驳回,就停止操作并报告审查失败。
  2. 删除所有获准的删除候选项,但声称约束存在于我们代码中的注释除外;第 4 步会处理这些注释。
  3. 对每项 MUST KILL 标记,在范围内实施最小的根因修复,例如删除死代码路径、移除未使用的参数、调用实际 API,或实施标记所指出的改动。不得扩大范围。如果原因超出范围,只进行范围内最小且安全的修复,并将其余工作报告为未完成。
  4. 对于声称约束存在于我们代码中的每项删除候选注释,提出成本最低的范围内类型约束、运行时检查、测试或 CI Lint 方案,并等待批准。若获批,就编码实现该约束并删除注释;否则保留注释并报告尚未落实的约束。
  5. 对每条保留的注释应用 unslop,法律或许可声明除外。
  6. 报告删除数量、保留的注释及其证据、重新审查次数、修复、约束编码情况、未落实的约束及其他未完成工作。

评论

支持 Markdown