Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.
Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.
Alexandra Mendes
Rodrigo Ferreira

Min Read

29. Dezember 2023

Was ist Code Review und wann sollten Sie es tun?

Überprüfung des Codes ist ein wichtiger Teil des Softwareentwicklungszyklus. Es ermöglicht Entwicklern, die Codequalität drastisch zu verbessern.

Der Prozess ist wie ein Buch zu schreiben. Der Autor erstellt die Geschichte, aber der Herausgeber überprüft sie, sodass es keine Fehler gibt, wie zum Beispiel „du bist“ mit „deins“ zu verwechseln. In diesem Fall Code-Review ist das Lesen und Bewerten des Codes anderer Leute. Ziel ist es, in einem frühen Stadium Verbesserungsmöglichkeiten oder Fehler zu finden, die sonst unbemerkt bleiben könnten. Die Code-Review-Prozesse finden in der Regel vor der Zusammenführung mit der Codebasis statt.

Wir werden jetzt die besprechen Vorteile des Code-Reviews und wie man es macht richtig. Und denken Sie daran, dass es bei der Erstellung von Software wichtig ist, Code-Reviews durchzuführen, egal ob für kleine oder große Projekte.

Warum ist Code Review wichtig?

Jedes Softwareprodukt, jede Website oder jede mobile App besteht aus Code. Je konsistenter dieser Code ist, desto bequemer wird es sein, damit zu arbeiten, beispielsweise wenn das Projekt geändert werden muss.

Ein perfekter Code sollte leicht zu verstehen, flexibel modifizierbar und lesbar sein. Da sich die Arbeit jedoch schnell entwickelt, werden diese Faktoren möglicherweise übersehen. Aus diesem Grund sind Verfahren zur Codeüberprüfung notwendig, um die Qualität zu verbessern.

Infolgedessen beschleunigt und rationalisiert die Codeüberprüfung den Softwareentwicklungsprozess.

Vorteile von Code Review

1. Sorgt für Konsistenz bei Design und Implementierung

Jeder Entwickler hat einen einzigartigen Programmierstil. Wenn Entwickler weiterhin ihren Programmierstil verwenden, behindert dies die Zusammenarbeit und verzögert den Fortschritt. Die Codeüberprüfung zwingt Entwickler dazu, bestimmte Programmierpraktiken zu befolgen. Mit diesem Ansatz werden alle Entwickler (auch neue) den Quellcode leichter verstehen.

Code-Reviews sind auch dann wertvoll, wenn sich die Teammitglieder im Laufe eines Projekts auf lange Sicht ändern. Die Beibehaltung eines konsistenten Codierungsmusters wird es zukünftigen Entwicklern auch ermöglichen, weniger Zeit mit der Analyse des vorhandenen Codes zu verbringen und stattdessen neue Funktionen zu entwickeln.

2. Optimierung des Codes für eine bessere Leistung

Selbst die erfahrensten Entwickler können Fehler bei der Programmierung aufgrund ihrer eintönigen Natur übersehen. Indem die Codeüberprüfung neue Augen dazu einlädt, die Codeeinheiten zu überprüfen, hilft das Code-Review dabei, Fehler zu vermeiden, bevor es weitergeht.

3. Zusammenarbeit und Austausch neuer Techniken

Im Allgemeinen arbeiten Entwickler alleine, und es ist leicht, einige Fehler zu machen. Mit unser Code-Audit-Service, es besteht die Möglichkeit, bessere Techniken zum Schreiben von Code zu erlernen und möglicherweise zu lernen, wie man es besser macht. Auf diese Weise können Entwickler ihre Fähigkeiten verbessern, indem sie sich mit den neuesten Technologien vertraut machen.

4. Verfolgung der Projektanforderungen und der Qualität

Projekte haben klar definierte Bereiche und Anforderungen. Aber einige unnötige Dinge können passieren, wenn an einem Projekt mehrere Entwickler beteiligt sind. Imaginary Cloud arbeitet eng mit Projektmanagern zusammen, um sicherzustellen, dass die Prozesse den Kundenbedürfnissen entsprechen.

Code Review verwaltet Szenarien, indem es die Entwicklung mit den Erwartungen vergleicht. Es validiert entwickelte Funktionen. Dadurch wird jede Fehlinterpretation des Umfangs oder der Anforderungen schnell behoben. Es hilft auch sicherzustellen, dass wichtige Funktionen nicht übersehen werden.

Obwohl Code-Reviews wie eine weitere Routineüberprüfung erscheinen, tun sie viel mehr als das. Code-Reviews verbessern die Zusammenarbeit, das Lernen, die zeitnahe Überprüfung und die optimierte Entwicklung.

blue arrow to the left
Imaginary Cloud logo

Wann und wer überprüft Prozesse

Code-Reviews finden nach allen Automatisierungsprüfungen statt und bevor der Arbeitszweig mit dem Hauptzweig zusammengeführt wird (Quellcode).

Im Code-Review-Prozess sind mindestens zwei Rollen vorhanden. Diejenigen, die Code schreiben und Pull-Requests erstellen, sind „Autoren“, und diejenigen, die den Code untersuchen, sind „Reviewer“. Der Rezensent und der Autor können anhand des folgenden Diagramms näher darauf eingehen:

Code Review Cycle.
Code-Review-Zyklus
blue arrow to the left
Imaginary Cloud logo

Wo sollte die Codeüberprüfung durchgeführt werden?

Der Prozess kann an vielen Stellen stattfinden, z. B. auf den Computern von Entwicklern, auf Online-Plattformen usw. In den folgenden Punkten werden die besten Praktiken für Überprüfungsprozesse erläutert.

  • Über der Schulter: Over-the-Shoulder-Code-Reviews finden am Schreibtisch eines Entwicklers statt, wo ein erfahrenes Teammitglied den neuen Code durchgeht und Vorschläge macht. Dieser Ansatz ist am einfachsten zu verwenden und benötigt keine vordefinierten Strukturen.
  • E-Mail-Weiterleitung: Der Code wird per E-Mail gesendet, sobald er fertig ist. E-Mails bieten zwar einen eher passiven Ansatz zur Codeüberprüfung, aber der Inhalt kann sich in mehreren Antworten verschachteln und schwierig zu verwalten und zu durchsuchen sein. Außerdem kann es schwierig sein, zu entscheiden, wann die Überprüfung abgeschlossen werden muss.
  • Paarprogrammierung: Mit dieser Methode können viele Entwickler an der Workstation anwesend sein, aber nur einer schreibt Code, und der andere gibt Feedback und Vorschläge in Echtzeit.

Es kann zwar als hilfreiches Tool für Teams dienen, um den Code zu überprüfen und Entwickler zu schulen, aber es könnte sich aufgrund seines zeitaufwändigen Charakters als ineffizient erweisen. Dieser Prozess hindert den Prüfer daran, während des Zeitraums andere produktive Arbeiten zu erledigen.

  • Tool-gestützt: Ein toolgestützter Code-Review-Prozess erleichtert die Codeüberprüfung. Es kann Open Source oder kostenpflichtig sein, wie GitHub, BitBucket usw. Heute bevorzugen es die meisten Leute. Es hilft im Allgemeinen bei:
    • Organisieren und Anzeigen der aktualisierten Dateien.
    • Bereitstellung eines Kommunikationskanals zwischen Rezensenten und Entwicklern.
    • Messung der Effektivität des Code-Review-Prozesses.
blue arrow to the left
Imaginary Cloud logo

Was sind die Best Practices für die Codeüberprüfung?

1. Erstellen Sie eine Checkliste für Code-Reviews

Die Code-Review-Checkliste ist eine strukturierte Methode, um sicherzustellen, dass der Code exzellent ist, bevor er akzeptiert wird. Einige der Artikel sind:

  • Funktionalität: Verhält sich der Code so, wie es der PR/MR-Autor wahrscheinlich beabsichtigt hat? Verhält sich der Code so, wie es die Benutzer erwarten würden?
  • Ablesbarkeit: Der Code sollte selbsterklärend sein. Verwenden Sie geeignete Namen für Variablen, Funktionen und Klassen.
  • Sicherheit: Setzt der Code das System Cyberangriffen aus? Sind weitere Tests erforderlich?
  • Architektur: Ist der Code gut gestaltet und an die umgebende Architektur angepasst?
  • Wiederverwendbarkeit: Verwendet der Code wiederverwendbare Komponenten, Funktionen und Dienste? Für einige Dinge, wie Struktur und Logik, können Sie Prüfungen automatisieren (z. B. statische Analysen).
  • Prüfungen: Verfügt der PR/MR über korrekte und gut durchdachte automatisierte Tests?
  • Kommentare: Sind die Kommentare klar und nützlich?

Andere, wie Design und Funktionalität, müssen von einem Menschen überprüft werden. Wenn Sie den Code anhand bestimmter Fragen überprüfen, können Sie sich auf die richtigen Dinge konzentrieren. Du könntest zum Beispiel Code testen, um folgende Fragen zu beantworten:

  • Ist klar, was der Code bewirkt?
  • Funktioniert es wie erwartet?
  • Erfüllt dieser Kodex die regulatorischen Anforderungen?

Wenn Sie sich den Code kritisch ansehen, stellen Sie sicher, dass Sie unter Berücksichtigung der Fragen nach den richtigen Dingen suchen. Das reduziert die Testzeit.

2. Führen Sie Kennzahlen zur Codeüberprüfung ein

Ohne Metriken können Sie die Codequalität nicht korrigieren. Die Messung objektiver Kennzahlen verbessert Ihre Bewertungen, bewertet die Auswirkungen von Prozessänderungen und sagt voraus, wie lange eine Aufgabe abgeschlossen sein muss. Zu den häufig verwendeten Bewertungskennzahlen gehören:

  • Inspektionsrate: Die Rate, mit der Ihr Team eine bestimmte Menge an Code überprüft. Sie wird berechnet, indem die Codezeilen durch die Anzahl der Inspektionsstunden geteilt werden. Wenn die Überprüfung des Codes lange dauert, kann es zu Problemen mit der Lesbarkeit kommen.
  • Fehlerrate: Die Häufigkeit, mit der ein Fehler festgestellt wurde, geteilt durch die Inspektionszeit. Die Metrik hilft Ihnen dabei, die Effektivität Ihrer Testverfahren zu ermitteln. Wenn Ihr Entwickler beispielsweise Fehler nur langsam findet, benötigen Sie möglicherweise bessere Testtools.
  • Defektdichte: Sie können es berechnen, indem Sie die Anzahl der Fehler durch Tausende von Codezeilen dividieren. Anschließend können Sie den anfälligsten Komponenten mehr Ressourcen zuweisen. Angenommen, eine Ihrer Web-Apps weist deutlich mehr Fehler auf als andere im Projekt. Möglicherweise sind erfahrenere Entwickler erforderlich, um daran zu arbeiten.

3. Halten Sie Ihre Code-Reviews unter 60 Minuten.

Es wird nicht empfohlen, den Code länger als 60 Minuten zu überprüfen. Ab diesem Zeitpunkt lassen die Leistung und die Liebe zum Detail nach. Es ist am besten, regelmäßig (in kurzen Sitzungen) Code-Reviews durchzuführen, damit sich Ihr Gehirn in den Pausen wieder aufladen kann. Dann kannst du es noch einmal mit frischen Augen überprüfen. Häufige Überprüfungen helfen Ihnen dabei, die Qualität der Codebasis zu verbessern.

4. Beschränken Sie Ihre Schecks auf 400 Zeilen pro Tag.

Der Versuch, viel Code auf einmal zu überprüfen, macht es schwieriger, Fehler zu finden. Beschränken Sie die Codeüberprüfungen auf jeweils 400 Zeilen oder weniger. Grenzwerte für Codezeilen sind ebenso wichtig wie Zeitlimits. Es hilft Ihnen, die beste Codebasis beizubehalten.

5. Geben Sie hilfreiches Feedback

Versuchen Sie konstruktiv zu sein, anstatt kritisch zu sein. Es ist einfacher, dies zu tun, indem Sie Fragen stellen, anstatt Aussagen zu treffen. Stellen Sie sicher, dass Sie sowohl konstruktives Feedback als auch Lob geben. Wenn Sie persönlich Feedback geben (oder sogar Ihre Bewertung abgeben), können Sie besser mit dem richtigen Ton kommunizieren. Die Bewertung ist eine Lernerfahrung, von der alle Beteiligten profitieren.

blue arrow to the left
Imaginary Cloud logo

Wie führt man Überprüfungsverfahren durch?

Wenn Sie sich entscheiden, selbst oder intern einen Code-Review durchzuführen, sollten Sie die folgenden Schritte ausführen:

  • Finden Sie heraus, wonach Sie bei einem Code-Review suchen.
  • Machen Sie sich mit den verschiedenen Methoden vertraut, um eine Code-Überprüfung durchzuführen.
  • Halten Sie regelmäßig Gruppentreffen ab, bei denen die Teilnehmer Feedback zu ihren jeweiligen Bereichen erhalten und gleichzeitig Hinweise zu Problemen erhalten.
  • Machen Sie Kommentare klar und spezifisch.
  • Seien Sie offen für Verbesserungen.
  • Stehen Sie für Diskussionen zur Verfügung.
  • Beginnen Sie mit kleinen Änderungen und überprüfen Sie dann komplexere Änderungen.
  • Halten Sie den Status eines Commits auf dem neuesten Stand.
blue arrow to the left
Imaginary Cloud logo

Der Fall Agile

In einer agilen Umgebung ist es möglich, Code-Reviews nahtlos durchzuführen.

Die Prämisse ist, sich an sich ändernde Anforderungen anzupassen, schneller auf Benutzerbedürfnisse zu reagieren, Prozesse zu rationalisieren, Entwicklungsiterationen zu verkürzen und eine höhere Produktivität zu ermöglichen. Dazu gehört die kontinuierliche Aufmerksamkeit für technische Exzellenz und die Fähigkeit, auf Veränderungen zu reagieren und gleichzeitig ein hohes Qualitätsniveau aufrechtzuerhalten.

Apple und Google sind bekannte Agile-Unternehmen, und die Qualität ihrer Produkte spiegelt diesen zusätzlichen Aufwand wider.

Die oben genannten Methoden für Code-Reviews sind ein Beispiel für agile Prozesse. Sie sind kostengünstiger und effektiver bei der Minimierung von Fehlern und der Verbesserung der Qualität des Quellcodes.

Codeüberprüfung spart Ihrem Unternehmen Geld

Ein Code-Review ermöglicht es Ihnen, Fehler zu beheben, die Konformität sicherzustellen und vor der Fertigstellung zu bestätigen, dass die Anwendung den Spezifikationen entspricht — obwohl es teurer wäre, diese Änderungen vorzunehmen.

Um zu sehen, woher die Zeit- und Kosteneinsparungen durch Code-Reviews kommen, müssen Sie den Prozess aus einer anderen Perspektive betrachten.

Fehler und Bugs zu erkennen und schnell zu beheben bedeutet, dass sie in der nächsten Entwicklungsphase keine Probleme verursachen. Wenn Sie sie nicht sofort erkennen, können sich der Zeit- und Kostenaufwand für die Überarbeitung vervielfachen. Das Systems Sciences Institute von IBM berichtet, dass Fehler bei der Implementierung behoben wurden kostet fünfmal mehr als bei Design und Architektur.


Darüber hinaus können Korrekturen in der Integrationstestphase während des Betatests zehnmal mehr kosten, nach der Veröffentlichung fünfzehnmal mehr und dreißigmal mehr.

blue arrow to the left
Imaginary Cloud logo

Warum sollten Sie jemanden mit Code-Reviews beauftragen?

In diesem Artikel besprechen wir zwar, wie ein Code-Review durchgeführt wird, aber in den meisten Fällen, wenn es um komplexere Projekte geht, kann dies viel Zeit und Ressourcen in Anspruch nehmen.

Aus diesem Grund könnte das Outsourcing der Codeüberprüfung aus folgenden Gründen sinnvoll sein:

  • Jemand mit einer neuen Perspektive sollte den Code überprüfen.
  • Entwickler, die am Projekt beteiligt sind, können weiter daran arbeiten und Funktionen oder Fortschritte hinzufügen, was wertvolle Zeit spart.
  • Effizienter Einsatz von Ressourcen (setzen Sie interne Experten in anderen Funktionen ein, in denen sie am dringendsten benötigt werden).
  • Diese Unternehmen haben bereits etablierte Methoden entwickelt, um den Prozess effizienter zu gestalten.

Wie wir sehen können, bietet dieser Service mehrere Vorteile. Aus diesem Grund Imaginary Cloud führt Code-Audits durch weil wir das Leben der Menschen vereinfachen wollen.

Imaginary Cloud code audit

blue arrow to the left
Imaginary Cloud logo
blue arrow to the left
Imaginary Cloud logo
Alexandra Mendes
Alexandra Mendes

Inhaltsautor mit großer Neugier auf die Auswirkungen der Technologie auf die Gesellschaft. Immer umgeben von Büchern und Musik.

Read more posts by this author
Rodrigo Ferreira
Rodrigo Ferreira

Softwareentwickler, der die Backend-Seite liebt, agil und RoR-süchtig ist. Ein Fußballfan und ein Enthusiast des Radsports. Lass uns reiten!

Read more posts by this author

People who read this post, also found these interesting:

arrow left
arrow to the right
Dropdown caret icon