Posted on

代码审查规范

当用户输入 review 时，按以下步骤自动执行代码审查：

执行流程

  1. 查看 unstaged 文件

    • 执行 git status 查看当前所有 unstaged 文件列表

  2. 筛选代码文件

    • 只审查代码文件（.ts、.js 等源代码文件）
    • 跳过以下类型的文件：
      • .meta 文件（Cocos Creator 元数据文件）
      • .prefab 文件（预制体文件）
      • .scene 文件（场景文件）
      • 图片、音频等资源文件（.png、.jpg、.mp3 等）
      • 其他非代码文件

  3. 审查内容

    • 读取筛选后的每个代码文件
    • 检查以下问题：
      • 代码风格是否符合项目规范
      • 是否遵循 development-standards.instructions.md 中定义的开发习惯
      • 是否有明显的逻辑错误或 bug
      • 是否有未处理的 null/undefined 检查
      • 是否存在不适当的错误处理
      • 命名是否清晰规范
      • 是否有多余的代码或死代码
      • 是否有性能问题

  4. 输出审查结果

    • 逐个文件列出发现的问题
    • 对每个问题提供具体建议
    • 如果没有问题，输出确认信息

审查标准

必须检查

  • 遵循 TypeScript 编码规范
  • 遵循项目中 development-standards.instructions.md 的约定
  • Button 事件监听是否使用规范的 on("click", handler, this) 写法
  • @property 节点是否添加了不必要的空值判断
  • 是否正确使用多语言 API
  • 动画是否使用了 cc.tween 方法
  • 弹窗节点是否遵循复用规范

参考检查

  • 代码可读性和维护性
  • 潜在的边界情况处理
  • 异常处理的完整性
  • 资源泄漏风险