code review需要关注哪些内容?
- 设计:代码的设计对于当前的功能及整体的系统是否是合适的。
- 功能:代码是否实现了所要求的功能。
- 复杂性:代码是否能够更简练。
- 测试:是否有足够且设计较好的自动化测试用例。
- 注释:注释是否清晰有用。
- 命名:代码中变量、类、方法等的命名是否表达了合适的意思。
- 风格:是否符合所要求的风格。
Note:不同的开发团队有不同的代码风格,代码风格是否合适应该取决于当前团队的整体风格。 - 文档:是否更新了相关文档。
谁来review?
code owner 应该是最好的,其次对整体的代码有足够了解的人。如果这些人没有时间来review代码,你应该在选择其他人的同时,将当前的PR抄送给这些人。
如果你当前采取的是结对编程(pair program)的话,且对方有能力review代码的话,review是可以省略的。
code review的目的是什么?
在整个的软件开发流程中,保证代码的健康。这里的健康是指,代码结构清晰,耦合度低,易于理解,方便重构。
作为reviewer,如何写code review的意见?
- 对保持谦虚和尊重。
- 给出你这样评论的原因
- 给出一些修改建议
- 接受对方的解释
如何去review代码?
- 浏览整个的change list,知道提交的代码在解决什么问题。
- 重点检查change list的主要部分
- 以合适的顺序浏览change list剩余的代码
对于change list 上整体上的概览,可以对当前的change list的设计和风格有一个基本的认识,能够更好的理解修改的代码。
最佳实践
-
change list
要小,这样避免reviewer耗费过多的时间来进行review - reviewer要尽快的进行review,如果不能及时review的话,请尽早驳回请求
- 尽可能的摒弃个人的喜好,按照团队统一的风格来进行review
- developer 要尽可能的详细描述所作的修改
- 鼓励pair program, 面对面的进行review
网友评论