Praktikum SDE Code Reviews

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.

Ihre Aufgaben

Recherchieren Sie was ein Code Review ist und wie dieses durchgeführt werden kann (s. Weblinks und Literatur).
Tragen Sie ihr Modul mit Link in die Tabelle ein, welches zu reviewen ist.
Tragen Sie sich als RevieW ein.
Führen Sie das Review anhand der Vorlage durch und dokumentieren Sie es hier: https://svn.hshl.de/svn/MTR_SDE_Praktikum/trunk/Testdokumente/CodeReviews/
Optimieren Sie Ihren Quelltext anhand des Code Reviews.
Besprechen Sie bis zur Deadline 20.12.19 das Ergebnis mit Prof. Schneider.

Review Zuordnung

#	Modul	Autor	Review von
1	BSF - Bahn- und Spurführung	Yanick Christian Tchenko
2			Yanick Christian Tchenko
3
4

Vorgehensweise bei der statischen Codeanalyse

Walk-Trough
Technisches Review
Inspektion

== Ablauf Code-Review

Bereitstellung des Codes
Vorbereitung des Prüfers
Autor führt Durch den Code (Walk-Trough)
Prüfer identifiziert Probleme
Befunde werden festgehalten
Autor arbeitet Befunde ein
Wiederholung/erneutes Review (GOTO 1)

Fragen des Reviewers

Wurden die Programmierrichtlinien eingehalten?
Wurde bei C Code Programmierung der MISRA Standard eingehalten?

Weblinks

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: Praktikum SDE