SuperAPI AI 工具集

clean-comments

编程与开发

查看项目

更新于 10-16 02:35

技能介绍

用途:按 ~/.claude/rules/comments.md 这一唯一标准,删除源码中不合格的注释。该文件是唯一副本,编辑前必须先读取并照其执行,不要凭记忆或在本技能中复述标准;标准未覆盖的情况应补充到 comments.md,而非本技能。

主要能力与用法:在提交前对暂存文件运行 /clean-comments;也可指定文件,如 /clean-comments src/foo.ts src/bar.go。无参数时通过 git diff --cached --name-only --diff-filter=ACM 获取暂存文件,筛选 .go、.ts、.tsx、.js、.jsx、.py、.rs 等代码文件,逐个读取、删除不符合标准的注释并写回,再用 git add <file> 重新暂存,最后报告删除了什么、来自哪些文件;若无需删除则说明。

限制与注意:只做注释编辑,绝不在同一轮改动代码。必须保留承载功能的指令,如 //go:build、// +build、//go:generate、// prettier-ignore、# fmt:、# -*- coding:、shebang。抑制类注释(@ts-ignore、eslint-disable、# type: ignore、//nolint)属于 comments.md § Suppressions 下的债务,应报告并说明各自屏蔽了什么,本轮绝不删除,因为删除会破坏构建或 lint,属于代码改动。提交钩子 ~/.claude/hooks/check-staged-comments.sh 在 Bash 的 PreToolUse 上运行,当暂存差异新增注释行时阻止 git commit;它忽略指令,且仅在 Python 中把 # 视为注释标记。精简长文档注释也算新增行,会触发该钩子;当剩余注释都合格时,可说明后使用 CC_COMMENTS_REVIEWED=1 git commit ... 提交。