Wie führe ich eine Codeüberprüfung durch? Teil 2: Navigation, Geschwindigkeit, Kommentare, Konflikte überprüfen

Im ersten Teil des Artikels wurden Aspekte der Standards für die Codeüberprüfung und Punkte hervorgehoben, die zuerst behandelt werden müssen. Lassen Sie uns im letzten Teil über Folgendes sprechen:


  • Überprüfungsverfahren
  • Geschwindigkeit (und was es beeinflusst)
  • wie man Kommentare schreibt,
  • Diskussion während der Überprüfung.

1. Navigation durch die Liste der Änderungen in der Überprüfung


TL; DR


Nachdem Sie verstanden haben, worauf Sie achten müssen, müssen Sie die Reihenfolge der Überprüfung festlegen. Es gibt 3 Hauptphasen:


  1. Verstehen Sie, ob die vorgestellte Funktionalität im Prinzip benötigt wird und ob sie eine gute Beschreibung hat ;
  2. Achten Sie auf das Wichtigste im geänderten Code und darauf, wie gut die Lösung insgesamt gestaltet ist.
  3. Zeigen Sie die verbleibenden Änderungen in der Reihenfolge an, die Sie für richtig halten.

1.1. Übersicht ändern


Schauen Sie sich die CL-Beschreibung und ihre Hauptfunktionalität an: Werden diese Änderungen benötigt? Wenn die vorgeschlagene Funktionalität nicht benötigt wird, versuchen Sie, sie so schnell wie möglich zu melden und die Gründe zu erläutern. In diesem Fall ist es ratsam, dem Entwickler im Gegenzug eine Aufgabe anzubieten.


: " , , , 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.


, , . .


, , , .


Selbst die leidenschaftlichsten Gegner strenger Überprüfungen können zu Ihren größten Verbündeten werden, wenn sie in der Praxis auf eine Situation stoßen, die beweist, dass Ihre schwierige Position in der Überprüfung korrekt war.


4.5. Konfliktlösung


Wenn Sie alle oben genannten Regeln befolgen, aber immer noch Konflikte mit den Entwicklern bestehen und diese nicht lösen können, lesen Sie die Code Review Standards , um die Praktiken und Standards zu verstehen, die Ihnen bei der Lösung des Konflikts helfen können.


All Articles