Code Review

Code Review

Mit dem Review werden Arbeitsergebnisse der Softwareentwicklung manuell geprüft. Jedes Arbeitsergebnis kann einer Durchsicht durch eine andere Person unterzogen werden. 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) unterschieden.

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

Inhaltsverzeichnis

Nutzen von Reviews

Fehler können häufig bedeutend kostengünstiger behoben werden, als wenn diese erst während der Testdurchführung gefunden werden. Untersuchungen haben gezeigt, dass mit Reviews 85% der Fehler bei einem Aufwand von 25% gefunden werden können.

Dabei laufen verschiedene Qualitätsprozesse ab:

  • Der Programmierer entdeckt selbst eine Verbesserungsmöglichkeit (oft Sekunden bevor der Reviewer diese sieht).
  • Der Rezensent stellt Verständnisfragen und der Programmierer kann die Antwort auf diese Fragen als Kommentare in den Programmcode einbauen und so die Verständlichkeit und die Dokumentation verbessern.
  • Der Rezensent entdeckt Verbesserungsmöglichkeiten und empfiehlt diese dem Programmierer.

Zu den typischen Fehlern die mit Reviews entdeckt werden können gehören:

  • Abweichungen von Standards
  • Fehler in den Anforderungen
  • Fehler im Design
  • Unzureichende Wartbarkeit
  • Falsche Schnittstellenspezifikation

Resultate sind verbesserter Code (Effizienz, Robustheit, Wartbarkeit) aber auch verbesserte Kommentare im Code (Wartbarkeit).

Reviewprozess

Ein typisches Review besteht aus folgenden Hauptphasen:

  • Planung
    • Auswahl der beteiligten Personen und Besetzung der Rollen
    • Festlegung der Vor- und Nachbedingungen
  • Kick-Off
    • Verteilung der Dokumente
    • Erläuterung der Ziele und des Prozesses
    • Prüfung der Vorbedingungen
  • Individuelle Vorbereitung
    • Notierung von potentiellen Fehlern, Fragen und Kommentaren
  • Reviewsitzung
    • Diskussion und Protokollierung der Ergebnisse
    • Empfehlungen geben oder Entscheidungen über Fehler treffen
  • Überarbeitung (rework)
    • Beheben der gefundenen Fehler, typischerweise durch den Autor
  • Nachbearbeitung (follow up)
    • Überprüfung der Überarbeitung
    • Prüfung von Testendekriterien

Reviewarten

Reviews variieren zwischen sehr informell (unstrukturiert) und sehr formal (d.h. gut strukturiert und geregelt). Die Art und Weise, wie ein Review durchgeführt wird, ist abhängig von den festgelegten Zielen des Reviews (z.B. das Finden von Fehlern, dem Erwerb von Verständnis oder einer Diskussion mit Entscheidung durch Konsens).

Nach Norm IEEE 1028 gibt es die folgenden vier Reviewarten:

  • Technisches Review
    • Fachliche Prüfung eines wesentlichen Dokumentes (z.B. Architekturentwurf) auf Übereinstimmung mit Spezifikation
    • Zweck: Diskussion, Entscheidungen treffen, Alternativen bewerten, Fehler finden, technische Probleme lösen
  • Informelles Review
    • 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. Demnach wird hier auf strukturierte Protokollierung/Dokumentierung verzichtet.
    • Es ist eine einfache Art eines Reviews, bei dem meistens „Gegenlesen unter Kollegen“ durchgeführt wird.
    • Inhaltlich können dieser Art folgende, praxisbezogene Reviewarten zugeordnet werden (Begriffe je nach Firmenkultur unterschiedlich):
      • Pulttest (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.)
  • Walkthrough
    • 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
  • Inspektion
    • Formalste Reviewtechnik mit einem dokumentierten Vorgehen nach IEEE 610, 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 Reviewprozess 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 öffentlicher Review ist ebenfalls eine Motivation der Open Source-Software.

Online-Software Repositories wie CVS erlauben es Gruppen von Individuen, gemeinschaftlich Codereviews durchzuführen, und damit Sicherheit und Qualität des Programmcodes zu verbessern.

Literatur

Weblinks


Wikimedia Foundation.

Игры ⚽ Нужно сделать НИР?

Schlagen Sie auch in anderen Wörterbüchern nach:

  • Code review — is systematic examination (often as peer review) of computer source code. It is intended to find and fix mistakes overlooked in the initial development phase, improving both the overall quality of software and the developers skills. Reviews are… …   Wikipedia

  • Code-Review — Mit dem Review werden Arbeitsergebnisse der Softwareentwicklung manuell geprüft. Jedes Arbeitsergebnis kann einer Durchsicht durch eine andere Person unterzogen werden. Das Review ist eine statische Testmethode und gehört in die Kategorie der… …   Deutsch Wikipedia

  • code review — 1. noun a) (uncountable) The practice of identifying and verifying the choice of algorithms, coding styles and compliance with the software design. After several painful episodes, weve decided to adopt code review for all major changes. b)… …   Wiktionary

  • Code review — Инспекция кода или рецензия кода или ревизия кода от (англ. Code review или англ. Code inspection)  систематическая проверка исходного кода программы с целью обнаружения и исправления ошибок, которые остались незамеченными в… …   Википедия

  • Automated code review — software checks source code for compliance with a predefined set of rules or best practices. The use of analytical methods to inspect and review source code to detect bugs has been a standard development practice. This process can be accomplished …   Wikipedia

  • Code Reading — (ISBN 0 201 79940 5) is a 2003 software development book written by Diomidis Spinellis. The book is directed to programmers who want to improve their code reading abilities. It discusses specific techniques for reading code written by others and… …   Wikipedia

  • Code reviewing software — is computer software that helps humans find flaws in program source code.In can be divided into two categories: * Automated code review software checks source code against a predefined set of rules and produces reports. * Different types of… …   Wikipedia

  • Review (Softwareentwicklung) — Mit dem Review werden Arbeitsergebnisse der Softwareentwicklung manuell geprüft. Jedes Arbeitsergebnis kann einer Durchsicht durch eine andere Person unterzogen werden. Das Review ist eine statische Testmethode und gehört in die Kategorie der… …   Deutsch Wikipedia

  • Review (Softwaretest) — Mit dem Review werden Arbeitsergebnisse der Softwareentwicklung manuell geprüft. Jedes Arbeitsergebnis kann einer Durchsicht durch eine andere Person unterzogen werden. Das Review ist eine statische Testmethode und gehört in die Kategorie der… …   Deutsch Wikipedia

  • Code refactoring — Refactor redirects here. For the use of refactor on Wikipedia, see Wikipedia:Refactoring talk pages. Code refactoring is disciplined technique for restructuring an existing body of code, altering its internal structure without changing its… …   Wikipedia

Share the article and excerpts

Direct link
Do a right-click on the link above
and select “Copy Link”