代码审查清单：提升团队代码质量

代码审查是保证质量的关键环节。本文提供一份全面的审查清单，帮助团队发现潜在问题。

功能性审查

✅ 功能正确性

• 代码是否实现了需求？
• 边界条件是否处理？（空值、负数、极大值）
• 错误处理是否完善？
• 是否有未处理的异常？

✅ 测试覆盖

• 是否添加了单元测试？
• 测试是否覆盖了主要场景？
• 测试是否可重复、独立？
• 现有测试是否通过？

代码质量

✅ 可读性

• 变量/函数命名是否清晰？
• 函数是否单一职责？
• 代码是否有不必要的复杂度？
• 是否有魔法数字？（应提取为常量）

# ❌ 难以理解
if status == 1:
    ...

# ✅ 清晰
if status == USER_STATUS_ACTIVE:
    ...

✅ 代码复用

• 是否有重复代码？（DRY 原则）
• 是否可以提取公共函数？
• 是否过度工程化？（YAGNI 原则）

✅ 注释与文档

• 复杂逻辑是否有注释？
• 注释是否解释了"为什么"而非"是什么"？
• 公共 API 是否有文档？
• 注释是否与代码同步更新？

安全性审查

✅ 输入验证

• 用户输入是否验证？
• SQL 是否使用参数化查询？（防注入）
• 文件上传是否有限制？
• 路径遍历是否防护？

✅ 认证授权

• 敏感操作是否需要认证？
• 权限检查是否到位？
• 密码是否加密存储？
• Token/密钥是否硬编码？

✅ 数据安全

• 敏感数据是否脱敏？
• 日志是否记录敏感信息？
• 是否使用 HTTPS？

性能审查

✅ 效率

• 是否有 N+1 查询问题？
• 循环中是否有数据库/网络调用？
• 是否使用了合适的数据结构？
• 是否有内存泄漏风险？

✅ 资源管理

• 文件/连接是否正确关闭？
• 是否使用了连接池？
• 大对象是否及时释放？

架构设计

✅ 模块化

• 代码是否符合分层架构？
• 模块间耦合是否合理？
• 依赖注入是否恰当？

✅ 可扩展性

• 是否便于添加新功能？
• 配置是否外部化？
• 是否考虑了未来扩展？

代码风格

✅ 规范一致性

• 是否符合团队代码规范？
• 缩进、空格是否一致？
• 命名风格是否统一？

✅ Git 提交

• 提交信息是否清晰？
• 提交是否原子化？（一个提交一件事）
• 是否删除了调试代码？

审查建议模板

正面反馈

✅ 做得好：
- 这个函数的命名非常清晰
- 错误处理很完善
- 测试覆盖全面

改进建议

💡 建议：
- 这里可以提取为一个公共函数
- 考虑添加空值处理
- 这个逻辑可以简化为...

必须修改

⚠️ 需要修改：
- 存在 SQL 注入风险，请使用参数化查询
- 缺少权限检查
- 这个 bug 会导致...

审查流程建议

1. 小步提交：每次 PR 不超过 400 行
2. 及时审查：24 小时内响应
3. 自动化先行：Lint、测试先过
4. 建设性反馈：对事不对人
5. 面对面讨论：复杂问题直接沟通

常见陷阱

❌ 吹毛求疵

关注重要问题，不要纠结于个人偏好。

❌ 只提问题不给方案

# ❌
这段代码有问题

# ✅
这里可能有性能问题，建议用 Map 替代数组查找

❌ 审查过慢

阻塞团队进度，失去审查意义。

结语

好的代码审查是团队成长的催化剂。建立文化，持续改进，代码质量自然提升。

---

你们团队的代码审查流程是怎样的？