Claude Code 注释清理技能:保留 Python 类型检查指令
EnglishClaude Code 安装步骤
- 打开 GitHub 固定提交的 `.claude/skills/comment-cleanup/SKILL.md`,核对内容与使用条件。
- 在自己的项目中创建 `.claude/skills/comment-cleanup/`,把核对后的文件保存为 `.claude/skills/comment-cleanup/SKILL.md`。
- 在该项目根目录启动 Claude Code,在斜杠菜单中选择 `/comment-cleanup`。
中文摘要
整理复述代码的 Python 注释和文档字符串,维持设计原因与功能性指令,并对比语法树确认执行逻辑。
SKILL.md 中文导读
可复现示例
准备一个清理标题字符串的辅助函数,放入复述返回动作的注释。另一行保留既有的类型检查指令。要求仅删掉失去信息价值的注释。
`normalize_title.py` · `# Return the normalized title` · `# type: ignore[arg-type]`工作步骤
- 把复述代码的注释与原因、边界条件和工具指令区分开。
- 只移除已确认无额外信息的说明。
- 比较语法树并运行类型检查,人工复核保留的工具指令。
验收方法
差异删除 `# Return the normalized title` 并保留 `# type: ignore[arg-type]`。忽略文档字符串后,两版语法树应一致。
GitHub 原文 · 更新日期
适用环境
用 Claude Code 打开 OpenCyphal 的 PyCyphal Python 检出或一个同样使用类型检查指令的练习仓库。记录初始差异,准备在前后比较语法树。
常见问题
仅检查语法树就够了吗?
类型检查和格式化指令可能不参与普通语法树比较。复核这些行并运行项目已有的类型检查,再审阅丢失的设计解释。