forked from datawhale/whale-town-end
style: 完善代码规范和测试覆盖
- 新增多个模块的单元测试文件,提升测试覆盖率 - 完善AI-Reading文档系统,包含7步代码检查流程 - 新增集成测试和属性测试框架 - 优化项目结构和配置文件 - 清理过时的规范文档,统一使用新的检查标准
This commit is contained in:
@@ -1,5 +1,21 @@
|
||||
# 步骤2:注释规范检查
|
||||
|
||||
## ⚠️ 执行前必读规范
|
||||
|
||||
**🔥 重要:在执行本步骤之前,AI必须先完整阅读同级目录下的 `README.md` 文件!**
|
||||
|
||||
该README文件包含:
|
||||
- 🎯 执行前准备和用户信息收集要求
|
||||
- 🔄 强制执行原则和分步执行流程
|
||||
- 🔥 修改后立即重新执行当前步骤的强制规则
|
||||
- 📝 文件修改记录规范和版本号递增规则
|
||||
- 🧪 测试文件调试规范和测试指令使用规范
|
||||
- 🚨 全局约束和游戏服务器特殊要求
|
||||
|
||||
**不阅读README直接执行步骤将导致执行不规范,违反项目要求!**
|
||||
|
||||
---
|
||||
|
||||
## 🎯 检查目标
|
||||
检查和完善所有注释规范,确保文件头、类、方法注释的完整性和准确性。
|
||||
|
||||
@@ -151,12 +167,36 @@ async methodName(paramName: ParamType): Promise<ReturnType> {
|
||||
- ✅ 实际修改文件内容时,才更新@lastModified字段
|
||||
- ✅ 使用Git变更检测确认文件是否真正被修改
|
||||
|
||||
### 🚨 重要强调:纯检查不更新修改记录
|
||||
**步骤2注释规范检查时,如果发现注释已经符合规范,无需任何修改,则:**
|
||||
|
||||
#### 禁止的操作
|
||||
- ❌ **禁止添加检查记录**:不要添加"AI代码检查步骤2:注释规范检查和优化"
|
||||
- ❌ **禁止更新时间戳**:不要修改@lastModified字段
|
||||
- ❌ **禁止递增版本号**:不要修改@version字段
|
||||
- ❌ **禁止修改任何现有内容**:包括修改记录、作者信息等
|
||||
|
||||
#### 正确的做法
|
||||
- ✅ **仅进行检查**:验证注释规范是否符合要求
|
||||
- ✅ **提供检查报告**:说明检查结果和符合情况
|
||||
- ✅ **保持文件不变**:如果符合规范就不修改任何内容
|
||||
|
||||
### 实际修改才更新的情况
|
||||
**只有在以下情况下才需要更新修改记录:**
|
||||
- 添加了缺失的文件头注释
|
||||
- 补充了不完整的类注释
|
||||
- 完善了缺失的方法注释
|
||||
- 修正了错误的@author字段(AI标识替换为用户名)
|
||||
- 修复了格式错误的注释结构
|
||||
|
||||
### Git变更检测检查
|
||||
```bash
|
||||
git status # 检查是否有文件被修改
|
||||
git diff [filename] # 检查具体修改内容
|
||||
```
|
||||
|
||||
**只有git显示文件被修改时,才需要添加修改记录和更新时间戳**
|
||||
|
||||
**注意:具体的时间更新规则请参考README.md中的全局约束部分**
|
||||
|
||||
## 🎮 游戏服务器特殊注释要求
|
||||
|
||||
Reference in New Issue
Block a user