程序员如何做「代码审查」:不是挑刺,是提升
代码审查(Code Review)是团队协作中最重要的环节之一。
但很多人把 CR 当成"挑刺",而不是"帮助"。
一、代码审查的目的
1. 发现问题
- Bug
- 安全漏洞
- 性能问题
2. 分享知识
- 让团队知道你在做什么
- 大家能从你的代码学到东西
- 你能从别人的反馈中学到东西
3. 保证质量
- 代码风格一致
- 设计合理
- 有测试覆盖
二、作为审查者
1. 先肯定,再提建议
"这个设计很好,逻辑很清晰。但这里有个小问题……"
2. 提建议,不是命令
"这里可以试试……" 而不是说 "这里必须改"。
3. 问问题,不做假设
"这个为什么要这样实现?" 而不是 "这样实现不对"。
4. 区分重要和非重要
- 重要:Bug、安全、架构
- 非重要:命名、格式(用工具自动化)
5. 尽快审查
收到 PR 后尽快审查,不要让对方等几天。
三、作为被审查者
1. 控制 PR 大小
一次审查不要超过 400 行。
太大 reviewer 会忽略细节。
2. 写好 PR 描述
- 这个 PR 做什么
- 为什么要这么做
- 怎么测试
3. 准备好回应
准备好解释你的设计选择。
4. 不要防御
审查是帮助,不是批评。
四、CR 的检查清单
功能
- 代码逻辑是否正确
- 边界情况是否处理
设计
- 架构是否合理
- 是否符合团队规范
安全
- 是否有注入风险
- 权限控制是否正确
性能
- 是否有性能问题
- 数据库查询是否需要优化
可维护性
- 代码是否清晰
- 是否有注释
- 是否有测试
五、一句话总结
代码审查 = 发现问题 + 分享知识 + 保证质量,不是挑刺,是帮助。