SuperAPI AI 工具集

remove-ai-comments

通用与其它

查看项目

更新于 10-15 17:33

技能介绍

用途:识别并删除 AI 编程助手常生成的低价值注释,例如复述代码结构、陈述显而易见内容或冗长的教程式说明,以提升代码库的可读性。

主要能力:按四类识别待删注释——“旁白型”(如 // Begin function、// Loop through the array)、“翻译型”(如 i += 1 // Increment i)、“分步教程型”(如 // Step 1: Get the data)、“占位型”(如 /* Your code here */,仅当实现已存在时移除 // TODO: implementation)。

保留规则:不删除文档字符串/JSDoc、解释“为什么”的注释(变通方案、优化、业务逻辑)、警告/注意事项、可执行的 TODO 或 FIXME(除非用户明确要求清除)。

工作流:1. 分析目标文件以理解其用途;2. 评估注释,可运行 python scripts/comment_density.py <file>(如可用)测量初始密度;3. 逐条处理,符合删除标准的删除,复杂逻辑注释保留或精简;4. 清理产生的连续空行与行尾空白。

示例:清理前含 # Import the datetime library 等注释,清理后仅保留必要代码。

限制:资料未提供安装方式、平台支持、收费信息及更详细的使用步骤。