| name | code-compliance-check |
| description | Automatically validates code changes for compliance. **MUST invoke IMMEDIATELY after completing ANY code modification task** to ensure quality, logging, and bug-free delivery. |
代码修改自动合规校验
触发条件
每次完成代码需求修改后自动执行。
校验规则
1. 精准修改原则
仅修改需求指定代码,不改动项目其他任何无关代码、模块、逻辑。
检查项:
- 确认所有修改与需求直接相关
- 验证未引入不必要的代码变更
- 检查是否有误删或误改无关代码
2. 单一职责原则
严格遵循单一职责原则,函数类功能单一,不耦合多业务逻辑,职责清晰。
检查项:
- 每个函数只负责一个明确的功能
- 类的职责边界清晰
- 避免上帝类和过大函数
- 逻辑分层合理
3. 日志规范要求
所有修改代码必须补充完整规范日志,包含流程日志、异常错误日志。
日志规范:
- 关键流程节点记录流程日志
- 异常捕获必须记录错误日志
- 日志级别使用正确(DEBUG/INFO/WARN/ERROR)
- 日志信息包含必要的上下文数据
- 敏感信息不得记录到日志
4. Android 原生控件,简单可靠,与现有 UI 风格一致
所有新增控件必须使用 Android 原生控件,避免使用第三方库控件。
检查项:
- 所有新增控件必须是 Android 原生控件
- 控件的使用必须符合 Android 原生控件的规范
- 控件的使用必须与现有 UI 风格一致
5. 代码质量检测
自动检测代码全部 Bug、语法问题、逻辑隐患,验证代码可在原项目正常运行。
检测内容:
- 语法错误检查
- 空指针风险检测
- 资源泄漏检测
- 并发安全问题
- 类型安全检查
- 边界条件处理
6. 问题修复与交付
自动修复所有问题,交付最终代码并附上自检报告。
交付物:
- 修复后的干净代码
- 自检报告(包含检测结果、修复记录、验证状态)
执行流程
1. 代码修改完成
↓
2. 精准修改校验
↓
3. 单一职责检查
↓
4. 日志规范检查
↓
5. 代码质量检测
↓
6. 问题自动修复
↓
7. 生成自检报告
↓
8. 交付最终代码
自检报告模板
## 代码合规自检报告
### 基本信息
- 修改文件:[文件列表]
- 修改类型:[新增/修改/删除]
- 关联需求:[需求描述]
### 校验结果
#### 1. 精准修改校验
- 状态:✅ 通过 / ❌ 不通过
- 说明:[详细说明]
#### 2. 单一职责检查
- 状态:✅ 通过 / ❌ 不通过
- 说明:[详细说明]
#### 3. 日志规范检查
- 状态:✅ 通过 / ❌ 不通过
- 说明:[详细说明]
#### 4. 代码质量检测
- 状态:✅ 通过 / ❌ 不通过
- 问题列表:
- [问题描述1]
- [问题描述2]
### 修复记录
| 序号 | 问题 | 修复方式 | 状态 |
|------|------|----------|------|
| 1 | ... | ... | ✅ |
### 最终结论
- 综合评估:✅ 合格交付 / ❌ 需要修正
- 备注:[其他说明]
注意事项
- 校验过程不可跳过任何步骤
- 发现问题必须修复后才能交付
- 自检报告必须真实反映检测结果
- 对于无法自动修复的问题,需人工介入确认