用途:在需要精简、清理、缩短或删除代码注释时使用。提供 normal 与 aggressive 两级:normal 为默认,缩短冗长注释但保留原意——更短而非晦涩,且从不删除;aggressive 删除几乎所有注释,仅当用户明确说“aggressive”“strip”“remove all”时才使用。
两条始终生效的规则:一、只编辑注释,绝不改动任何一行可执行代码;二、范围上,除非用户指定文件,只处理改动的代码——先看未提交的本地 diff,再看 PR diff,仅当明确要求时才触及整个代码库。
各注释类型处理方式:重述型注释(如 // create user)、叙述型注释(如 // loop over users)、回声式文档字符串(如 Gets name)在 normal 下缩短,aggressive 下删除;普通 why 注释 normal 保留(缩短),aggressive 删除;TODO/FIXME/HACK 在 normal 保留,aggressive 删除;文档注释(如 godoc)在 normal 保留(缩短),aggressive 下若 lint 需要则留桩,否则删除;不常见的工作绕过/陷阱说明在 normal 保留(缩短),aggressive 下保留但修剪到最短。工具指令(如 //go:generate 等)与许可证/版权头在两级下都绝不触碰。
说明:特殊绕过指非显而易见的陷阱、正在规避的 bug、或“必须这样做否则 X 会坏”的提示,aggressive 会保留但压缩到仍能传达原因的最短形式。工具指令(//go:generate、//go:embed、# noqa、# type: ignore、// eslint-disable、// @ts-expect-error、// nolint)和许可证头看似注释却并非噪音——删除会改变行为或涉及法律效力,两级都绝不触碰。
限制:资料未提供安装命令、平台支持、收费与具体调用示例;使用前应确认用户是否明确要求 aggressive。