晋级资料

进阶提升 · 工程化实践 — 代码规范与审查体系

Code Review规范清单子智能体

代码规范 Check 清单

生成适合项目的 Review 智能体

根据项目实际情况，生成一份代码开发完成后的 Review Check 清单。

提示词
请根据我项目的情况，帮我生成一份代码开发完成之后 Review check 清单
Check 的内容涉及以下这些方向：
1. 统一接口响应规范
2. 软删除规范
3. API 设计规范
4. 权限认证规范
5. 异常处理规范
6. 参数校验规范
7. 日志记录规范
8. 命名规范
9. 分页排序规范
10. 状态枚举规范
11. 文件上传规范
12. 安全规范
13. 事务规范
14. 第三方接口调用规范
包含但不限于以上规则，同时要考虑我们项目的实际情况

附加准则

  • 数据库结构变更必须采用 Prisma ORM 的标准 migration 迁移流程
  • 审查完成之后，要生成一个 check 报告
  • 生成的内容不要超过 5000 个字

子智能体配置

创建代码审查子智能体

生成的内容可以让 AI 生成一个子智能体，也可以直接放在项目根目录下。在开发完成几个模块后，拖动此文件给 AI 让 AI Review 代码。

提示词
帮我在这个项目之下创建一个子智能体
用来进行开发之后的代码审查

审查流程

使用方式

  • 时机 — 在完成几个功能模块开发之后进行
  • 方式 — 将 Check 清单文件拖给 AI，让其逐项审查
  • 输出 — 生成审查报告，包含通过项和待修改项
  • 迭代 — 根据报告修改后再次审查

规范检查项一览

接口响应规范软删除规范API 设计规范权限认证规范异常处理规范参数校验规范日志记录规范命名规范分页排序规范状态枚举规范文件上传规范安全规范事务规范第三方接口调用规范

晋级要点

  • 渐进式添加规则 — 不要一开始就添加所有规则，在完成基础开发后再逐步添加
  • 项目级 vs 用户级 — 一定要添加到 project 级中，不要放到 user 级
  • 工具适配
    • Cursor — 在设置 rules/subagent 中添加（new → project rule）
    • Claude — 在根目录下的 CLAUDE.md 文件中添加
  • 内容控制 — 生成的审查内容不超过 5000 字，保持精炼可执行