如何进行代码审查?第2部分:查看导航,速度,评论,冲突

本文的第一部分重点介绍了代码审查标准的各个方面以及需要首先解决的要点。在最后一部分,让我们讨论:


  • 审查程序
  • 速度(及其影响)
  • 如何写评论,
  • 审查期间的讨论。

1.浏览审阅中的更改列表


TL; DR


现在您已经了解了需要注意的内容,您需要确定审阅的顺序。有3个主要阶段:


  1. 了解原则上是否需要所提供的功能,以及是否具有良好的描述 ;
  2. 要注意修改后的代码中最重要的事情,以及解决方案的整体设计水平;
  3. 按照您认为合适的顺序查看其余的更改。

1.1。变更总览


查看CL描述及其主要功能:是否需要这些更改?如果不需要建议的功能,请尝试尽快报告并解释原因。在这种情况下,建议向开发人员提供任务作为回报。


: " , , , FooWidget, . . , BarWidget . ?"


, : CL . : , .


, , , — , . "" , , .


1.2.


CL — , . — . CL , , CL .


CL, , CL . , , — .


:


  • CL . , .
  • . , , , .

1.3.


CL , . . , . — .


2.


2.1. - ?


Google , , , . , .


, - :


  • . , , , . , , , , .
  • . , . . , , , CL , . , .
  • . , . , CL.

2.2. ?


- , , .


( , , ).


, CL ( ) .


2.3. vs


, : - , , , . , , . , , , .


: , , , .


2.4.


-, , , , , CL . , .


, , .


, , , CL , . . , — .


, , . , , .


2.5.


, , , , . , .


2.6. LGTM (looks good to me = )


, , CL . :


  • , .
  • , .

LGTM , "LGTM, Approval".


2.6. CL


CL , CL CL, . , .


CL , , CL, , . , , .


2.7. -


, , . , CL . . , , — , .


2.8.


, CL . . , , " ".


3.


TL;DR


  • .
  • .
  • , , .
  • , .

3.1.


, , , , . — , . , , , -, . :


: " , ?"


: " , , . , , ."


3.2.


"" , . , — , .


3.3.


CL, . .


. , , . , , , , , , , , .


, . , CL , — , .


3.4.


, , , . , , , , .


, , . : , , , , , .


4.


, .


4.1. ?


, — , . , . ? ? , .


, . , . , - .


, , , . .


, . , . , .


4.2. ?


, , . , , , , , . , , , . , , .


4.3. " "


( ) , . , - CL, . CL . , , CL, - . , . , — , , , "". .


CL , CL , . CL , , , , TODO- .


4.4.


, , . .


, , , .


在实践中,即使最热心的严格审查反对者也可能成为您最大的盟友,他们遇到的情况证明您在审查中的强硬立场是正确的。


4.5。解决冲突


如果您遵循上述所有规则,但是与开发人员之间仍然存在冲突,并且您无法解决它们,请参考“ 代码审查标准”以了解可以帮助您解决冲突的实践和标准。


All Articles