关于 remove-ai-comments
指导清理代码中低价值注释的技能，面向希望减少冗余注释的开发者。它区分应删除的旁白式、复述式和占位注释，以及应保留的文档和决策说明。
主要功能
- 01识别叙述代码结构的注释
- 02识别复述代码的注释
- 03清理教程式步骤注释
- 04保留文档与原因说明
- 05处理后清理空行和空白
适用场景
- 01清理 AI 生成的冗余注释
- 02移除模板遗留的空注释
- 03在精简注释时保留重要说明
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/remove-ai-comments确认已加载。
附带文件README.mdscripts/comment_density.py
详细介绍
删除“AI 风格”的注释
目的
本技能旨在指导移除 AI 编码助手经常生成的低价值注释。这些注释通常会复述代码结构、陈述显而易见的内容，或使用冗长的“教程式”解释，让专业代码库显得杂乱。
识别指南
识别并移除属于以下类别的注释：
1. “旁白式”注释
用于宣布常见代码结构开始的注释。
- 移除：
// Begin function - 移除：
// Loop through the array - 移除：
// Define variables - 移除：
// Initialize class - 移除：
// End of if statement
2. “翻译式”注释
只是把代码行翻译成英文，没有补充上下文的注释。
- 移除：
i += 1 // Increment i - 移除：
return result // Return the result - 移除：
print(error) // Print the error
3. “分步说明式”注释（AI 教程风格）
用于解释常见逻辑流程的编号步骤。
- 移除：
// Step 1: Get the data - 移除：
// Step 2: Validation - 移除：
// Step 3: Return response
4. “占位符”注释
模板遗留的空注释或不包含实际内容的注释。
- 移除：
// TODO: implementation（仅当实现已经完成时） - 移除：
/* Your code here */
保留规则（不应移除的内容）
不要移除：
- 文档字符串/JSDoc：描述输入、输出和公共接口的 API 文档。
- “原因”注释：解释做出某项决策原因的注释（例如，特定的变通方案、优化或业务逻辑理由）。
- 警告：
WARNING、CAUTION，或关于副作用的说明。 - 待办事项：可执行的
TODO或FIXME项（除非用户明确要求清除）。
工作流
- 分析：阅读目标文件，了解其用途。
- 评估：查看注释。运行
python scripts/comment_density.py <file>（如果可用）以评估初始注释密度。 - 处理：
- 遍历注释。
- 如果某条注释符合“识别指南”中的移除条件，就将其删除。
- 如果注释解释了复杂逻辑，则保留它；如果注释过于冗长，也可以精简。
- 清理：删除由此产生的多余空行或行尾空格。
示例
之前（AI 风格）：
# Import the datetime library
import datetime
# Function to get the current date
def get_date():
# Step 1: Get today's date
today = datetime.date.today()
# Step 2: Return it
return today
之后（清理后）：
import datetime
def get_date():
return datetime.date.today()
评论
支持 Markdown