SuperAPI AI 工具集

no-comments

编程与开发

查看项目

更新于 10-28 16:16

技能介绍

用途

no-comments 是一个代码注释审查技能,用于处理 Pstack 注释审查、不必要的叙述性注释,以及掩盖代码问题的抑制性注释。它通过生成专门的子智能体来审查代码中的注释,判断哪些注释应当删除、保留或转化为可执行的检查。

主要能力

  • 通过 /swarm 生成名为 Comment Sicko 的子智能体,并传递审查范围。
  • 审查调用者指定的文件或 diff;若未指定,则使用当前 diff 与基础分支(默认 main)对比,包含工作区。
  • 传递仓库文档化的注释约定。
  • 检查子智能体报告与 diff,拒绝应用代码修改、范围越界、受异常保护的删除、错误陈述的 MUST KILL 理由,以及对有意保留代码的错误标记。
  • 审计遗漏的作用域内 lint 和 TypeScript 抑制;正确性或安全性抑制保持为可执行的 MUST KILL。
  • 对薄弱的 IMPORTANT 或“不要移除”类 kill/keep,先运行 /how 或 /why 检查其符号。
  • 直接修复简单的已接受标记:删除死路径、去掉参数、使用真实 API。
  • 若修复需要设计,运行 /architect 一次,为已接受集合及周边代码生成草图,止于草图。
  • 实施作用域内最小的根因修复,移除所有具名变通方案;若根因超出范围,则落地最小作用域内修复并报告其余未解决。
  • 对约束性注释(如“不要移除”“不要改措辞”“改前先联系 X”),提供最廉价的作用域内类型、运行时、测试或 CI lint 方案,等待交互式批准;无人值守和评估场景需要调用者预先批准。
  • 最终报告删除数量、恢复的注释、重跑、架构草图、修复、编码提议、编码、未强制约束及其他未完成工作。

使用方式

该技能通过 /swarm 生成 Comment Sicko 子智能体,并传递审查范围。调用者需提供文件或 diff;若未提供,则默认使用当前 diff 与 main 分支对比。技能会依据仓库文档化的注释约定执行。对于简单修复直接处理;对于需要设计的修复,运行 /architect 一次生成草图,然后由步骤 4 实施。约束性注释需要交互式批准,无人值守和评估场景需要调用者预先批准。

适用场景

  • 代码审查中需要清理不必要的叙述性注释。
  • 需要识别并处理掩盖代码问题的抑制性注释。
  • 需要审计遗漏的 lint 或 TypeScript 抑制。
  • 需要将约束性注释转化为可执行的检查(类型、运行时、测试或 CI lint)。
  • 需要实施最小根因修复并移除变通方案。

限制

  • 不授权扩大范围或修复范围外的实例。
  • 不添加症状防护。
  • 对于模糊的 kill 不恢复;对于被反驳或仍模糊的 keep 则删除。
  • 约束性注释的编码需要交互式批准;无人值守和评估场景需要调用者预先批准。
  • 若根因超出范围,仅落地最小作用域内修复并报告其余未解决。
  • 具体支持的平台、收费、价格等信息暂未提供。