Code Review 检查清单：提升代码质量的 15 个要点

一、功能正确性

1. 需求实现

• 代码是否实现了所有需求？
• 边界情况是否处理？
• 异常场景是否有适当处理？

2. 逻辑正确

• 条件判断是否完整？
• 循环是否有终止条件？
• 是否有死代码或 unreachable code？

二、代码质量

3. 可读性

• 变量、函数命名是否清晰？
• 函数是否过长？(建议<50 行)
• 是否有必要的注释？

4. 可维护性

• 是否有重复代码？(DRY 原则)
• 模块职责是否单一？(SRP 原则)
• 依赖关系是否合理？

5. 性能考虑

• 是否有不必要的循环嵌套？
• 数据库查询是否优化？
• 是否有内存泄漏风险？

三、安全性

6. 输入验证

• 所有用户输入是否验证？
• 是否有 SQL 注入风险？
• 是否有 XSS 风险？

7. 认证授权

• 敏感操作是否验证权限？
• 密码是否加密存储？
• Token/Session 管理是否安全？

8. 数据安全

• 敏感信息是否脱敏？
• 日志是否泄露敏感数据？
• API 是否有速率限制？

四、测试

9. 单元测试

• 核心逻辑是否有单元测试？
• 测试覆盖率是否达标？
• 测试用例是否覆盖边界情况？

10. 集成测试

• 关键流程是否有集成测试？
• 外部依赖是否有 Mock？

五、规范与约定

11. 代码风格

• 是否符合团队代码规范？
• 缩进、空格是否一致？
• 导入顺序是否规范？

12. 错误处理

• 错误是否有明确提示？
• 是否记录适当日志？
• 是否避免吞掉异常？

六、文档

13. 代码注释

• 复杂逻辑是否有注释？
• 公共 API 是否有文档？
• 注释是否准确且及时更新？

14. README 更新

• 是否更新使用说明？
• 是否更新配置说明？
• 是否更新部署文档？

七、其他

15. 兼容性

• 是否影响现有功能？
• 数据库迁移是否兼容？
• API 变更是否向后兼容？

Code Review 心态建议

Reviewer:

• 对事不对人
• 提出问题的同时给出建议
• 认可好的设计

Author:

• 保持开放心态
• 解释设计思路
• 及时响应反馈

总结

Code Review 不仅是找 bug，更是知识分享和质量提升的过程。建立检查清单，形成习惯，团队代码质量会持续提升。