原始
## 核心要求
1. **注释规范化**
- 所有注释需使用中文
- 为所有函数添加中文注释
- 为所有函数内部代码块添加中文注释
- 每个步骤注释需简明扼要(单句说明,不超过 30 字)
2. **现有注释处理**
- 保留含以下特殊标记的注释:
▶ 标签结构:`[tag]: [内容]`
▶ 任务标记:`- [ ] 待办事项`
- 删除冗余的步骤说明类注释,按当前代码逻辑重新编写
3. **内容优化**
- 合并新旧注释中的重复信息
- 避免技术细节过度解释(如不说明具体算法原理)
4. **格式规范**
- 使用 4 个空格作为缩进单位
- 移除注释块之间的多余空行
- 保持注释与对应代码的缩进对齐
CRISP 框架
[Context] 作为资深代码规范审查与重构助手,
[Input] 现有代码库及其注释
[Request] 请对代码进行注释规范化重构
[Specifications] 要求:
- **格式:**
- 使用 4 个空格缩进(非制表符)。
- 移除注释块之间的多余空行。
- 严格保持注释与对应代码的缩进对齐。
- **注释内容:**
- **语言:** 所有注释必须使用中文。
- **范围:**
- 为每个函数添加中文注释(说明函数功能)。
- 为函数内部主要逻辑代码块添加中文注释(说明步骤目的)。
- **表达:**
- 每个注释需简明扼要,单句说明,不超过 30 字。
- 合并新旧注释中的重复信息。
- 避免过度解释技术细节(不说明具体算法原理)。
- **现有注释处理:**
- **保留:** 含有特定标记结构的注释:
- 标签结构:`[tag]: [内容]` (例如 `note: 用户ID`)
- 任务标记:`- [ ] 待办事项` (例如 `- [ ] 实现缓存更新`)
- **删除与重写:**
- 删除冗余的、仅描述步骤的旧注释。
- 根据当前代码逻辑,为相应步骤重新编写简明注释。
[Purpose] 目的是大幅提升代码可读性、可维护性,确保注释简洁、一致、实用,并保留特殊功能性标记。
TAG 框架
任务:请对代码进行注释规范化重构
范围:如果有输入,则使用输入的代码或选定的代码;否则则处理所有代码
要求:
- **格式:**
- 使用 4 个空格缩进(非制表符)。
- 移除注释块之间的多余空行。
- 严格保持注释与对应代码的缩进对齐。
- **注释内容:**
- **语言:** 所有注释必须使用中文。
- **范围:**
- 为每个函数添加中文注释(说明函数功能)。
- 为函数内部主要逻辑代码块添加中文注释(说明步骤目的)。
- **表达:**
- 每个注释需简明扼要,单句说明,不超过 30 字。
- 合并新旧注释中的重复信息。
- 避免过度解释技术细节(不说明具体算法原理)。
- **现有注释处理:**
- **保留:** 含有特定标记结构的注释:
- 标签结构:`[tag]: [内容]` (例如 `note: 用户ID`)
- 任务标记:`- [ ] 待办事项` (例如 `- [ ] 实现缓存更新`)
- **删除与重写:**
- 删除冗余的、仅描述步骤的旧注释。
- 根据当前代码逻辑,为相应步骤重新编写简明注释。
目标:目的是大幅提升代码可读性、可维护性,确保注释简洁、一致、实用,并保留特殊功能性标记。