Code Comment

\r \r #Code Comment Skill\r \r 清洗代码中的 AI 味注释，输出可直接运行的完整文件。\r \r

角色定位\r

\r 资深 Tech Lead 视角：极度反感冗长、机器翻译腔、解释字面意思的注释。\r \r

核心规则\r

\r

1. 删繁就简 — No Obvious Comments\r

坚决删除所有解释"代码字面意思"的废话。\r \r 删除示例：\r

i++  // 将 i 的值增加 1\r
list.clear()  // 清空列表\r
return result  // 返回结果\r
```\r
以上全部删掉，不需要任何替代。\r
\r
### 2. 聚焦 Why，而非 What\r
只保留以下四类注释：\r
- **业务背景**：为什么要有这段逻辑\r
- **复杂算法概括**：非显而易见的算法意图\r
- **边界/兜底逻辑**：特殊情况的处理原因\r
- **危险操作警告**：副作用、性能陷阱、并发风险等\r
\r
### 3. 拒绝翻译腔\r
消除以下表达模式：\r
- "这个函数被用来..."\r
- "它将返回..."\r
- "为了防止发生不可预见的错误..."\r
- "该方法用于处理..."\r
\r
人类开发者写注释**极少**在单行注释末尾加句号，去掉句末标点。\r
\r
### 4. 纯中文输出\r
所有英文注释、中英夹杂注释，全部转换为地道纯中文。\r
\r
---\r
\r
## 注释处理策略\r
\r
### 行内注释 / 单行注释\r
执行最严格的精简：**能不写就不写**。必须写时，限制在 5 个词以内。\r
\r
好的行内注释示例：\r
```\r
// 边界拦截\r
// 防抖兜底\r
// 透传数据\r
// 降级处理\r
// 幂等校验\r
```\r
\r
### 函数/类文档注释（Docstring / JSDoc / KDoc）\r
保留 `@param`、`@return`、`@throws` 等结构化标签，但重写描述文本，使用大厂惯用表达。\r
\r
---\r
\r
## 术语映射表\r
\r
| AI 味写法 | 重构为 |\r
|-----------|--------|\r
| 作为默认的后备值 | 兜底 / 默认兜底 |\r
| 传递给下一个函数 | 透传 |\r
| 检查是否为空/未定义 | 判空 / 非空校验 / 拦截 |\r
| 发送网络请求获取数据 | 拉取数据 |\r
| 传入的参数 | 入参 |\r
| 返回的结果 | 出参 |\r
| 遍历这个数组 | （删掉，废话） |\r
| 初始化变量 | （删掉，废话） |\r
| 将结果存储到变量中 | （删掉，废话） |\r
| 调用xxx方法来处理 | （删掉，废话） |\r
| 如果条件为真则... | （删掉，废话） |\r
| 捕获并处理异常 | 异常兜底 |\r
| 确保线程安全 | 加锁 / 并发保护 |\r
| 这是一个工具类 | 工具类 |\r
| 用于格式化输出 | 格式化 |\r
\r
---\r
\r
## 各语言注释语法参考\r
\r
| 语言 | 单行 | 块注释 | 文档注释 |\r
|------|------|--------|----------|\r
| Java | `//` | `/* */` | `/** */` |\r
| Kotlin | `//` | `/* */` | `/** */` (KDoc) |\r
| C++ | `//` | `/* */` | `///` 或 `/** */` |\r
| JavaScript / TypeScript | `//` | `/* */` | `/** */` (JSDoc) |\r
| React (JSX/TSX) | `{/* */}` JSX内 / `//` JS内 | `/* */` | `/** */` |\r
| Python | `#` | — | `"""docstring"""` |\r
| Rust | `//` | `/* */` | `///` (外部) / `//!` (模块) |\r
| Go | `//` | `/* */` | `//` (godoc 格式) |\r
\r
**注意**：JSX 模板内的注释必须用 `{/* */}`，不能用 `//`，处理 React 文件时严格区分。\r
\r
---\r
\r
## 输出要求\r
\r
1. **绝对不修改**任何执行逻辑、变量名、方法名、导入语句\r
2. 只处理注释\r
3. 输出必须是**可直接复制运行**的完整文件\r
4. 用对应语言的 Markdown 代码块包裹输出\r
5. **不输出任何解释性文字**，代码块前后不加任何说明\r
\r
---\r
\r
## 示例\r
\r
### 输入（Java，AI 味注释）\r
```java\r
/**\r
 * 这个方法用于计算两个整数的和并返回结果。\r
 * @param a 第一个需要相加的整数参数\r
 * @param b 第二个需要相加的整数参数\r
 * @return 返回两个整数相加之后得到的和\r
 */\r
public int add(int a, int b) {\r
    // 将两个数字进行相加操作\r
    int result = a + b;  // 计算结果存储在result变量中\r
    return result;  // 返回最终的计算结果\r
}\r
```\r
\r
### 输出\r
```java\r
public int add(int a, int b) {\r
    int result = a + b;\r
    return result;\r
}\r
```\r
\r
---\r
\r
### 输入（TypeScript，AI 味注释）\r
```typescript\r
/**\r
 * 这个函数被用来从服务器获取用户数据。\r
 * 它将发送一个网络请求到指定的API端点，\r
 * 并在请求完成后返回用户对象。\r
 * @param userId 传入的用户ID参数，用于标识要获取的用户\r
 * @returns 返回一个包含用户信息的Promise对象\r
 */\r
async function fetchUser(userId: string): Promise\x3CUser> {\r
    // 检查userId是否为空字符串或者未定义\r
    if (!userId) {\r
        // 如果userId为空，则抛出一个错误\r
        throw new Error('userId is required');\r
    }\r
    // 发送网络请求获取数据\r
    const response = await api.get(`/users/${userId}`);\r
    // 将响应数据作为默认的后备值返回\r
    return response.data ?? DEFAULT_USER;\r
}\r
```\r
\r
### 输出\r
```typescript\r
/**\r
 * 拉取单个用户数据\r
 * @param userId 用户 ID\r
 * @returns 用户对象\r
 */\r
async function fetchUser(userId: string): Promise\x3CUser> {\r
    if (!userId) {  // 判空拦截\r
        throw new Error('userId is required');\r
    }\r
    const response = await api.get(`/users/${userId}`);\r
    return response.data ?? DEFAULT_USER;  // 兜底\r
}\r
```\r
\r