xianyan/.windsurf/workflows/code-review.md

description

description
代码审查和质量检查

代码审查工作流

用于审查代码质量、规范性和潜在问题。

执行步骤

1. 检查文件头部注释

   • 确保每个文件包含标准注释：创建时间、更新时间、名称、作用、上次更新内容
   • 检查注释格式是否符合规范

2. 检查代码规范

   • 验证是否优先使用 Cupertino 组件（iOS 风格）
   • 检查颜色、圆角、按钮等 UI 元素是否使用统一的设计值
   • 确认代码符合 Flutter 最佳实践

3. 检查空指针安全

   • 验证所有可能为 null 的变量都有适当的空值检查
   • 确认状态管理组件进行了空指针检测
   • 检查是否有可能导致卡死闪退的代码

4. 检查代码结构

   • 确认文件行数不超过 1000 行
   • 检查是否需要合并小于 200 行的文件
   • 验证类和方法是否有必要的注释

5. 检查响应式设计

   • 确认布局支持不同屏幕尺寸
   • 验证组件是否响应式适配

6. 检查调试功能

   • 确认是否需要添加调试按钮/布局
   • 验证测试数据是否方便开发者使用

7. 检查 CHANGELOG

   • 确认代码修改是否已记录到 CHANGELOG.md
   • 验证版本号是否需要更新
   • 检查是否只保留最近 5 个版本号

8. 生成审查报告

   • 列出发现的问题
   • 提供修复建议
   • 标记问题优先级