In einem 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 Norm IEEE 730 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 Entwickler eine gute Möglichkeit, sich schnell und praxisorientiert weiterzubilden.
Nutzen von Reviews
Der Einsatz von Reviews führt zu einer deutlichen Reduktion von Fehlern. Laut Capers Jones’ Studien von ca. 12.000 Projekten führen Requirements Reviews zu einer Reduktion der zu erwartenden Fehler um 20 % bis 50 %, Top-level Design Reviews zwischen 30 % und 60 %, detaillierte funktionelle Design Reviews zwischen 30 % und 65 % und detaillierte logische Design Reviews zwischen 35 % und 75 %. Das entspricht in etwa der Effektivität von Systemtests (25 % bis 65 % aller Fehler).[1] Laut Steve Mcconnel finden Design- und Code-Reviews ca. 60 % aller Fehler.[2]
Dabei laufen verschiedene Qualitätsprozesse ab:
- Der Programmierer entdeckt selbst eine Verbesserungsmöglichkeit.
- Der Rezensent stellt Verständnisfragen und der Programmierer kann den Code so verändern (beispielsweise durch geeignete Namensgebung oder Dokumentation), dass diese Fragen beantwortet sind und so die Verständlichkeit verbessert wurde.
- Der Rezensent entdeckt Verbesserungsmöglichkeiten und empfiehlt diese dem Programmierer.
Zu den typischen Schwächen, die mit Reviews entdeckt werden können, gehören:
- Abweichungen von Standards, z. B. Verletzung von Namenskonventionen
- Fehler gegenüber (oder auch in) den Anforderungen
- Fehler im Design
- Unzureichende Wartbarkeit
- Falsche Schnittstellenspezifikation
Resultate von Code-Reviews sind neben den damit gefundenen Fehlern eine verbesserte Codequalität. Diese wiederum verhindert zukünftige Fehler und steigert die Effizienz; Robustheit; Wartbarkeit, z. B. durch verringerte Komplexität. Darüber hinaus können Fehler, die im Review auffallen, häufig bedeutend kostengünstiger behoben werden, als wenn diese erst während der Testdurchführung gefunden werden. Reviews und Inspections können die Softwareentstehungskosten um bis zu 30 % reduzieren.[1]
Reviewprozess
Ein typisches Review besteht aus folgenden Hauptphasen:
- Auswahl der beteiligten Personen und Besetzung der Rollen
- Festlegung der Vor- und Nachbedingungen
- Verteilung der Dokumente
- Erläuterung der Ziele und des Prozesses
- Prüfung der Vorbedingungen
- Notierung von potentiellen Fehlern, Fragen und Kommentaren
- Diskussion und Protokollierung der Ergebnisse
- Empfehlungen geben oder Entscheidungen über Fehler treffen
- Beheben der gefundenen Fehler, typischerweise durch den Autor
- Überprüfung der Überarbeitung
- Prüfung von Testende-Kriterien
Reviewarten
Reviews variieren zwischen sehr informell (unstrukturiert) und sehr formal (d. h. tief strukturiert und geregelt). Die Art und Weise, wie ein Review durchgeführt wird, ist abhängig von den festgelegten Zielen des Reviews (z. B. dem Finden von Fehlern, dem Erwerb von Verständnis oder einer Diskussion mit Entscheidung durch Konsens).
Die Norm IEEE 1028 unterscheidet die folgenden Reviewarten:[3]
- Fachliche Prüfung eines wesentlichen Dokumentes (z. B. Architekturentwurf) auf Übereinstimmung mit der Spezifikation
- Zweck: Diskussion, Entscheidungen treffen, Alternativen bewerten, Fehler finden, technische Probleme lösen
- Entspricht inhaltlich dem technischen Review, es soll ihm gegenüber aber Zeit gespart werden und daher wird es als nicht formaler Prozess durchgeführt.
- Das informelle Review ist nicht im IEEE-Standard für Software Reviews enthalten.
- Eine strukturierte Protokollierung/Dokumentierung ist möglich. Ein Bericht wird in der Praxis meist nur in einer einfacheren Form erstellt oder teils ganz ausgelassen.
- Es ist eine einfache Art eines Reviews, bei dem meistens „Gegenlesen unter Kollegen“ durchgeführt wird.
- Inhaltlich können dieser Art folgende, praxisbezogene Review-Arten zugeordnet werden (Begriffe je nach Firmenkultur unterschiedlich):
- Schreibtischtest (Programm-Autor spielt den Code anhand von einfachen Testfällen gedanklich durch.)
- Peer Rating (Gutachten, das von gleichgestellten Programmierern anonym über ein Programm erstellt wird.)
- Stellungnahmeverfahren (Autor verteilt Arbeitsergebnis an ausgewählte Gutachter zur Beurteilung.)
- Diskussion von Szenarien, Probeläufen und Alternativen im Kreis gleichgestellter Mitarbeiter mit möglichst niedrig gehaltenem Aufwand
- Zweck: Lernen, Verständnis erzielen und Fehler finden
- Formalste Reviewtechnik mit einem dokumentierten Vorgehen nach IEEE 1028.
- Zweck: Sichtüberprüfung von Dokumenten, um Mängel zu finden (z. B. Nichteinhaltung von Entwicklungsstandards, Nicht-Konformität gegenüber Spezifikationen usw.).
Erfolgsfaktoren
Damit Reviews erfolgreich durchgeführt werden, müssen verschiedene Bedingungen erfüllt sein:
- Definition von klaren Zielen
- Auswahl von geeigneten Personen
- Konstruktive Kritikfähigkeit (gefundene Fehler werden objektiv zur Sprache gebracht und positiv aufgenommen)
- Psychologische Aspekte (insbesondere Sicherstellung einer positiven Erfahrung für den Autor)
- Auswahl der geeigneten Reviewtechnik
- Unterstützung des Reviewprozesses durch das Management
- Existenz einer Kultur von Lernen und Prozessverbesserung
Anforderungen an Rezensenten:
- Er darf den Code nicht selbst geschrieben haben.
- Er muss Taktgefühl haben: Codereviews können für den Programmierer unangenehm sein, da er den Eindruck bekommen könnte, der eigene Code werde kritisiert. Wenn der Rezensent nicht taktvoll vorgeht, wird Widerstand und Ablehnung gegen die Durchsicht der Quelltexte aufgebaut.
Reviews als Philosophie
Kontinuierliches Inspizieren des Quelltextes wie bei der Paarprogrammierung ist auch eine der Methoden des Extreme Programming. Die im Extreme Programming (XP) eingesetzte Paarprogrammierung wird auch als „Codereview während der Entwicklung“ bezeichnet.
Ein öffentliches Review ist ebenfalls eine Motivation der Open-Source-Software.
Online-Software-Repositories wie Github, GitLab oder Bitbucket erlauben es Gruppen von Individuen, gemeinschaftlich Codereviews durchzuführen und damit Sicherheit und Qualität des Programmcodes zu verbessern. Es lässt sich dabei beispielsweise festlegen, dass eine Mindestanzahl an Reviewern eine Änderung für gut befunden haben müssen, bevor es möglich ist diese Änderung in den restlichen Code zu integrieren.
Darüber hinaus ist es auch möglich Problemstellen, die durch Werkzeuge für statische Codeanalyse im zu reviewenden Code erkannt wurden, entsprechend zu markieren, wodurch diese Probleme ebenfalls im Rahmen des Reviews behandelt werden.
Einzelnachweise
- ↑ a b Capers Jones, Chief Scientist Emeritus: Software Quality in 2002: A Survey of the State of the Art. (pdf; 234 kB) Software Productivity Research an Artemis company, 23. Juli 2002, S. 56, abgerufen am 15. Oktober 2013 (englisch).
- ↑ Steve McConnel: Code Complete. 2. Auflage. Microsoft, 2005, ISBN 978-3-86063-593-3, 21.3. Formal Inspections, S. 530 (940 S.): „Individual inspections typically catch about 60% of defects, which is higher than other techniques except prototyping and high-volume beta testing“
- ↑ 1028-2008 - IEEE Standard for Software Reviews and Audits. Abgerufen am 2. Februar 2013.
Literatur
- M.E. Fagan: Design and code inspections to reduce errors in program development. IBM Systems Journal Vol. 15(3), 1976, S. 182–211.
- Hansruedi Tremp: IT-Systeme prüfen. Compendio Verlag. 2. Auflage 2007. ISBN 978-3-7155-9304-3.
- Peter Rösler, Maud Schlich, Ralf Kneuper: Reviews in der System- und Softwareentwicklung. Grundlagen, Praxis, kontinuierliche Verbesserung. dpunkt.Verlag, Heidelberg 2013, ISBN 978-3-86490-094-5.
