mcpField
T
trim-comments

trim-comments

github.com/lwlee2608开发1171 次安装今天更新
代码仓库

关于 trim-comments

用于精简代码注释的技能，提供普通和激进两种模式。默认只处理变更代码中的注释，且不会修改可执行代码行。

主要功能

  1. 01普通模式缩短注释
  2. 02激进模式删除大多数注释
  3. 03普通模式保留 TODO、FIXME 和 HACK
  4. 04默认仅处理变更代码
  5. 05保留工具指令和许可证头

适用场景

  1. 01精简本地差异中的注释
  2. 02按明确要求删除注释
  3. 03缩短注释并保留变通原因
  4. 04清理注释时确保代码不变

安装

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

$npx skills add https://github.com/lwlee2608/agent-skills --skill trim-comments

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

详细介绍

精简注释

减少冗余注释。普通（默认）模式会缩短冗长的注释，但保留原意——更简短，不晦涩；绝不删除。激进模式会删除几乎所有注释。只有在用户明确要求时（“aggressive”“strip”“remove all”）才使用激进模式。

始终遵守两条规则：

  • 只编辑注释——绝不更改可执行代码行。
  • **范围：**除非用户指定文件，否则只精简改动过的代码——先处理未提交的本地差异，再处理 PR 差异。只有在用户明确要求时，才处理整个代码库。

各模式的处理方式

COMMENT TYPE                          NORMAL              AGGRESSIVE
─────────────────────────────────────────────────────────────────────
Restatement (// create user)          shorten             DELETE
Narration (// loop over users)        shorten             DELETE
Echo docstring (Gets name)            shorten             DELETE
Plain why-comment                     keep (shortened)    DELETE
TODO / FIXME / HACK                   keep                DELETE
Doc comment (godoc etc.)              keep (shortened)    stub if lint needs it, else DELETE
Unusual workaround / gotcha           keep (shortened)    KEEP but trim shorter
─────────────────────────────────────────────────────────────────────
Tooling directives (//go:generate…)   never touch         never touch
License / copyright headers           never touch         never touch

注意事项

  • 特殊变通方案 = 不明显的注意事项、用于规避 Bug 的方案，或“必须执行 X，否则 Y 会出问题”之类的说明。激进模式会保留这些注释，但会精简到仍能说明原因的最短形式。
  • 工具指令（//go:generate、//go:embed、# noqa、# type: ignore、// eslint-disable、// @ts-expect-error、// nolint）和许可证标头看起来像注释，但并非冗余内容——删除它们会改变行为或产生法律影响。无论哪种模式都绝不修改。

评论

支持 Markdown