Hallo habr Ich präsentiere Ihnen die Übersetzung des Artikels „6 Tipps für eine erfolgreiche Codeüberprüfung“ .
Die Codeüberprüfung war schon immer die grundlegende Praxis, sauberen und wartbaren Code zu erstellen.
Oft vernachlässigen und unterschätzen Entwickler die Codeüberprüfung aus Gründen, die zu diesem Zeitpunkt objektiv korrekt erscheinen.
Formulieren wir heute 6 Tipps, um eine qualitative und fruchtbare Codeüberprüfung durchzuführen .
I - Wählen Sie den richtigen Moment
Die Codeüberprüfung beginnt mit der Auswahl des richtigen Zeitpunkts .
Versuchen wir seine Eigenschaften zu beschreiben:
- Geringe Wahrscheinlichkeit einer Unterbrechung : Sie sollten Arbeitszeiten vermeiden, in denen Menschen erfahrungsgemäß vom Arbeitsprozess ablenken. In der Tat haben einige Tage häufig ruhigere Perioden, und gerade in solchen Momenten lohnt es sich, eine Codeüberprüfung zu planen.
- Ein sauberer und klarer Verstand : Sie sollten vor Beginn der Überprüfung und während des Prozesses keinen Stress erleben, z. B. weil Sie ein bevorstehendes Treffen mit dem Kunden befürchten. Außerdem muss sich der Programmierer, dessen Code überprüft werden soll, in einem ruhigen Zustand befinden, damit zwischen Ihnen keine Spannungen bestehen, die den Prozess der Überprüfung des Codes zerstören können.
- Der Entwickler garantiert, dass der Code zur Überprüfung bereit ist : Es macht keinen Sinn, Zeit damit zu verschwenden, sich das anzusehen, was noch nicht fertig ist. Mit Bereitschaft ist gemeint, dass der Code ohne schlechte Praktiken funktioniert, dokumentiert ist und zumindest durch Unit-Tests abgedeckt wird. Wenn ein Entwickler erfahrungsgemäß selbst Zeit für eine Codeüberprüfung zur Verfügung stellt, gibt er mit größerer Wahrscheinlichkeit einen Code zur Überprüfung an, für den er sich nicht schämt.
II - Grenzen setzen
Es lohnt sich, den bevorstehenden Umfang der Codeüberprüfung im Voraus zu verstehen.
Betrachten Sie eine oder mehrere Funktionen? Ist es angesichts der Zeit sinnvoll, zu viel in Betracht zu ziehen?
In der Regel möchte ich mich auf eine begrenzte Anzahl von Änderungen konzentrieren, um besser zu verstehen, worum es geht, und nicht zu oft zwischen Codeteilen wechseln.
Um die Grenzen der Aufgabe korrekt festzulegen, können Sie:
- Führen Sie zugewiesene Aufgaben mit einer sichtbaren Größe aus . Teilen Sie dazu große Aufgaben in kleine und atomare auf, zum Beispiel in Jira oder sogar auf dem klassischen Scrum-Board.
- Priorisieren Sie die Codeüberprüfung richtig : Wenn zu viele Aufgaben auf die Überprüfung warten, können Sie nicht alles sehen. Wählen Sie die Priorität.
III - Stellen Sie die richtige Atmosphäre ein
Stellen Sie vor Beginn einer Codeüberprüfung eine günstige Atmosphäre um Sie herum her.
Was wird dafür benötigt?
- Minimale Anzahl von Nebengeräuschen : Sie sind produktiver, wenn Sie möglichst wenig Lärm hören. Denn je kleiner es ist, desto besser ist die Konzentration.
- Es gibt keine "Unterbrechungszone" : Ähnlich wie im ersten Teil beschrieben, sollten Momente vermieden werden, in denen sie sich aus dem Prozess herausreißen können. Es ist einfacher, dies in einem separaten Raum zu tun.
- Zone positiver Kritik : Die Kritik an der Arbeit eines anderen ist ein komplexer Prozess. Aber es ist noch schwieriger, dies zu tun, wenn viele Leute da sind. In einem geschlossenen Raum können Sie frei sprechen, ohne befürchten zu müssen, dass Sie belauscht werden.
IV - Chatten, chatten und nochmal chatten
Die Codeüberprüfung ist keine Einbahnstraße.
Eine erfolgreiche Codeüberprüfung hängt in hohem Maße von der Fähigkeit ab, mit einem Kollegen respektvoll und effektiv zu kommunizieren. Schließlich erklärt nicht nur der Inspektor, was richtig ist und was nicht.
Code Review ist ein Gespräch über alles: Umfang, Absichten, Korrekturen und sogar Meinungsverschiedenheiten.
Versuchen Sie dabei, die folgenden Empfehlungen einzuhalten:
- Nicht nur zuhören, sondern auch hören : Meinungen und Meinungen sind oft unterschiedlich, und jede Meinungsverschiedenheit muss zu einer konstruktiven Diskussion des Themas führen. Jeder Standpunkt braucht Aufmerksamkeit.
- Neutraler Ton : Das Überprüfen des Codes ist keine Prüfung oder Inquisition. Sie haben das Gefühl, den Code beurteilen zu müssen, nicht die Person, die ihn geschrieben hat.
- Zweifel Qual - spezifizieren Sie : wenn Sie nicht sicher sind, über die spezifischen Implementierungsdetails, fragen Sie danach. Einige auf den ersten Blick nicht offensichtliche Absichten führen in Zukunft häufig zu Fehlinterpretationen.
V - Erinnere dich an das ultimative Ziel
Die Codeüberprüfung sollte zum Endergebnis führen : Es kann konstruktive Kritik und Tipps zur Verbesserung oder Integration des Codes in die entsprechenden Entwicklungszweige geben, die in gitflow ausgewählt wurden.
Dies liegt in der Verantwortung des Gutachters.
Aber wie beurteilen Sie, ob Code integriert werden kann?
Hier sind einige Kriterien, um bei der Entscheidung zu helfen:
- Der geschriebene Code löst das in der Anweisung beschriebene Problem.
- Der Code wird durch Unit-Tests korrekt abgedeckt .
- Zusammenführungskonflikte wurden korrekt gelöst.
- Es gibt keine offensichtlichen Anzeichen von Codegeruch oder schlechten Praktiken .
VI - Verwenden Sie Spezialwerkzeuge
Es gibt Tools zur einfachen Codeüberprüfung. Sie können sie ohne zu zögern verwenden, um den Prozess der Codeüberprüfung und -integration zu vereinfachen.
Auf dem Markt für Code-Verifizierungssoftware sind drei Marken führend: Smartbear (mit Collaborator) , Perforce (mit Helix Swarm) und Atlassian (mit Crucible).
Solche Tools bieten häufig umfangreiche Tools zum Organisieren der Codeüberprüfung sowie Metriken, um Ihr Team ständig zu verbessern.
Dies ist weit mehr als Tools zum Vergleichen von Code. Sie lassen sich in nahezu alle verfügbaren Versionskontrollsysteme integrieren .
Probieren Sie es aus!
Sie sind dran zu teilen!
Wenn Sie zusätzliche Tipps oder spezifische Beispiele haben, die Ihnen im täglichen Leben der Entwickler passiert sind, teilen Sie diese in den Kommentaren mit.