enhance-comment

自动清理代码中的低价值注释,提升代码整洁度。

安装使用

复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:

帮我安装这个 AI Skill:enhance-comment。
它的用途是:自动清理代码中的低价值注释,提升代码整洁度。
完整的 Skill 内容见:https://321skill.com/skills/enhance-comment/raw/index.md
请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。

提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。

使用示例

“请使用enhance-comment技能检查并清理这段代码中的注释。”,它会自动扫描代码,识别出类似‘// 这里设置初始值’这样的低价值注释并将其移除,同时保留函数说明和复杂的逻辑解释,最后输出清理后的代码并报告注释密度变化。

介绍

在AI辅助编程日益普及的今天,代码中常常会留下大量由AI生成的、冗余或显而易见的注释,如“初始化变量”、“步骤1:执行X”等。这些注释不仅降低了代码的专业性和可读性,还可能增加维护成本。enhance-comment 正是为了解决这一问题而生,它能智能识别并移除这些低价值的“AI风味”注释,同时保留有意义的文档字符串、关键解释和待办事项。

使用方式非常简便。你可以通过提供的npx命令将其作为一个Skill添加到Claude兼容的环境中,或者手动将技能文件夹复制到指定目录。之后,在AI助手进行代码审查或重构时,即可调用此技能来优化代码注释。它还会提供一个脚本,用于分析清理前后的注释密度变化,让你直观看到优化效果。

此技能非常适合所有需要编写和维护高质量代码的开发者,特别是那些频繁使用AI生成代码或接手包含大量AI注释项目的工程师。它帮助开发者从繁杂的注释噪音中解脱出来,专注于代码逻辑本身。

在使用时,建议先对代码库进行备份,并在非关键分支上运行清理操作,以便审查效果。虽然技能会尽力保留重要注释,但在处理极其复杂的代码或特殊格式的注释时,仍建议进行人工复查,以确保没有误删关键信息。

核心特点

与通用的代码格式化或注释清理工具不同,本技能专门针对AI生成的、模式化的低价值注释进行精准识别和移除,而非无差别地删除所有注释或仅调整格式。它内置了对“AI风味”注释模式的识别逻辑,能有效区分冗余说明和必要文档。

注意事项

不适合需要保留所有历史注释(包括简单注释)以进行代码考古或特定文档生成的场景。

常见问题

它会删除所有注释吗?

不会,它会智能识别并主要删除AI生成的、冗余或显而易见的低价值注释,保留有意义的文档字符串和解释。

支持哪些编程语言?

主要针对通用编程语言中的注释模式,具体支持范围请参考技能仓库的详细说明。

给 AI 助手的安装指引

如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:

请访问 https://321skill.com/skills/enhance-comment/raw/index.md 读取 enhance-comment 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。