Anleitung zum Code Review

Einleitung

Mit dem Review werden Arbeitsergebnisse der Softwareentwicklung manuell geprüft. Jedes Arbeitsergebnis kann einer Durchsicht durch eine andere Person unterzogen werden. Der oder das Review ist eine statische Testmethode und gehört in die Kategorie der analytischen Qualitätssicherungsmaßnahmen.

In Anlehnung an die IEEE-Norm 729 ist das Review ein mehr oder weniger formal geplanter und strukturierter Analyse- und Bewertungsprozess, in dem Projektergebnisse einem Team von Gutachtern präsentiert und von diesem kommentiert oder genehmigt werden.

Der untersuchte Gegenstand eines Reviews kann verschieden sein. Es wird vor allem zwischen einem Code-Review (Quelltext) und einem Architektur-Review (Softwarearchitektur, insbesondere Design-Dokumente) unterschieden. Diesen Bereichen zugeordnet sind technische Dokumente wie etwa Readmes, Installationsanweisungen oder Bedienungsanleitungen, aber auch Programme oder Skripte, die für eine Installation gebraucht werden, sowie Dokumente mit Informationen und Anweisungen an andere, ähnlich qualifizierte Entwickler, um diese zu befähigen, den Übersetzungsvorgang der Quellen zu einem späteren Zeitpunkt erfolgreich zu reproduzieren, etwa für ein Bug-Fixing (Fehlerkorrektur) oder eine Weiterentwicklung.

Beim Code-Review wird ein Programmabschnitt nach oder während der Entwicklung von einem oder mehreren Gutachtern Korrektur gelesen, um mögliche Fehler, Vereinfachungen oder Testfälle zu finden. Dabei kann der Gutachter selbst ein Softwareentwickler sein. Für unerfahrene Entwickler bietet der Code-Review durch einen erfahrenen Programmierer eine gute Möglichkeit, sich schnell und praxisorientiert weiterzubilden.

Dieser Vortrag gibt einen Überblick über das Thema Code Review.

Ein Code Review

optimiert den Quelltext (zuverlässigere und schnellere Software),
reduziert Kosten seitens der Firma, da eine behebung von Fehlern nach der Auslieferung von Software sehr teuer werden kann,
erhöht die Kundenzufriedenheit, da geprüfte Software ausgeliefert wird,
ist eine systematische Überprüfung des Codes durch eine oder mehrere Personen,
dient der Sicherstellung von Softwarequalität,
findet Fehlern und Unklarheiten und
sichert die Einhaltung von Programmierrichtlinien.

Formen des Code Reviews

Formell
- Inspektion
- Technisches Review
Informell
- Walktrough
- Reverse Code Review

Ablauf Code-Review

Autor stellt den Quellcodes bereit.
Autor initiiert eine Code Review Anfrage.
Autor führt den Prüfer durch den Code (Walktrough).
Prüfer identifiziert Probleme (Inspektion).
Prüfer prüft den Code und dokumentiert die Funde (Code_Review_Vorlage.docx).
Prüfer gibt das Dokument an den Autor zurück.
Autor arbeitet Befunde ein.
Autor initiiert eine neue Runde des Review-Prozesses (GOTO 1).

Worauf sollten Sie beim Code Review generell achten?

Funktion des Codes generell verständlich?
Ist der Code gut dokumentiert?
Sind Bereiche des Codes einfacher, leistungsfähiger umsetzbar?
Funktioniert der Code in allen Anwendungsfällen korrekt?

Tipps

Tipps zum Durchführen eines Code Reviews

Gehen Sie davon aus, dass bei der Programmierung Fehler gemacht wurden.
Definieren Sie Regeln und Ziele klar.

für den Autor

Nutzen Sie erläuternde Kommentare.
Reviewer liegt nicht immer 100% richtig.
Aus den Fehlern lernen.

für den Reviewer

Nie mehr als 400 Zeile Code gleichzeitig prüfen.
Nicht länger als 60 Minuten auf einmal prüfen.
Zeit lassen beim prüfen
Mit Checkliste arbeiten
Nur auf Fehler hinweisen und nicht selber fixen
Fehler genau dokumentieren
Lernen durch Review von Code

Tools

Weblinks

Zitate

[SB1: Smartbear.com: Why Review Code]
[SB2: Best practices for peer code review]
[SD16: Code Reviews - Techniques and Tips]
[JI16: Code Review]
[KIT1: Code Review]

Literatur

Gransberger, R.: Code Reviews: Techniken und Tipps. URL: https://speakerdeck.com/rgra
Best Kept Secrets of Peer Code Review, Cohen, Smart Bear Inc., 2006
Understanding Open Source Software Peer Review: Review Processes, Parameters and Statistical Models, and Underlying Behavioursand Mechanisms, Rigby, Dissertation, 2011
Mäntylä, M.; LASSENIUS, C.: Code Review Defects. IEEE 2007. URL: http://lib.tkk.fi/Diss/2009/isbn9789512298570/article5.pdf
Dukanivic, S.: D08-QM-3 Prozessbeschreibung zur Durchführung von Code-Reviews und Sicherstellung der Dokumentationsqualität. Darmstadt: Technischer Bericht, 21.06.2013

→ zurück zum Hauptartikel: Seminar SDE WS 19/20