Anleitung zum Code Review: Unterschied zwischen den Versionen

Version vom 3. Januar 2020, 12:35 Uhr

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.

Vorgehensweise bei der statischen Codeanalyse

Walktrough
Inspektion

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).

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

@@ Zeile 1: / Zeile 1: @@
+[[Kategorie:HowTo]]
+Autor: [[Benutzer:Ulrich_Schneider| Prof. Schneider]]
 == 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.
@@ Zeile 10: / Zeile 13: @@
 Dieser Vortrag gibt einen Überblick über das Thema Code Review.
-==Ihre Aufgaben==
+Ein Code Review
-* Recherchieren Sie was ein Code Review ist und wie dieses durchgeführt werden kann.
+* optimiert den Quelltext (zuverlässigere und schnellere Software),
-* Welche Tool können hier unterstützen? Freeware?
+* reduziert Kosten seitens der Firma, da eine behebung von Fehlern nach der Auslieferung von Software sehr teuer werden kann,
-* Präsentieren Sie dieses Thema anhand von Beispielen anschaulich.
+* 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.
-==Kür-Aufgabe==
+== Vorgehensweise bei der statischen Codeanalyse ==
-Machen Sie doch eine Umfrage unter Ihren Kommilitonen (Semester 1-7) welche Firmen Code Reviews einsetzen und warum. Das wäre aber schon das ++ hinter der 1.
+# Walktrough
+# Inspektion
-==Mögliche Fragen==
+== Ablauf Code-Review==
-* In welchen Schritten geht man beim Code-Review vor?
+# Autor stellt den Quellcodes bereit.
-* Warum macht man Code Reviews?
+# Autor initiiert eine Code Review Anfrage.
-* Wie laufen Reviews ab?
+# Autor führt den Prüfer durch den Code (Walktrough).
-* Welche Tools gibt es?
+# Prüfer identifiziert Probleme (Inspektion).
-* Formulieren Sie Tipps für Entwickler und Reviewer.
+# Prüfer prüft den Code und dokumentiert die Funde (Code_Review_Vorlage.docx).
-* Welche Hürden gibt es?
+# Prüfer gibt das Dokument an den Autor zurück.
-* Wie lässt sich das auf ihr Studium übertragen?
+# Autor arbeitet Befunde ein.
+# Autor initiiert eine neue Runde des Review-Prozesses (GOTO 1).
+== Weblinks ==
+* [[Anleitung_zum_Code_Review|HSHL-Wiki: Anleitung zum Code Review]]
+* [https://de.wikipedia.org/wiki/Review_(Softwaretest) Wikipedia: Review (Softwaretest)]
+* [https://www.doag.org/formes/pubfiles/6774263/2015-null-Rabea_Gransberger-Code_Reviews__Techniken_und_Tipps-Praesentation.pdf Code Reviews: Techniken und Tipps]
+* [https://www.johner-institut.de/blog/fda/code-review/ Code Review - Checkliste, Tools & Guidelines]
+* [https://svn.hshl.de/svn/MTR_SDE_Praktikum/trunk/Testdokumente/CodeReviews/Code_Review_Vorlage.docx Word SVN: Vorlage für Code Reviews]
+== Zitate ==
+* [https://smartbear.com/learn/code-review/why-review-code/?_ga=2.207847569.2041553548.1576511351-1414243424.1574687504 [SB1]: Smartbear.com: Why Review Code]
+* [https://smartbear.de/learn/code-review/best-practices-for-peer-code-review/ [SB2]: Best practices for peer code review]
+* [https://speakerdeck.com/rgra/code-reviews-techniques-and-tips-rheinjug-2016?slide=10 [SD16]: Code Reviews - Techniques and Tips]
+* [https://www.johner-institut.de/blog/fda/code-review/ [JI16]: Code Review]
+* [https://sdqweb.ipd.kit.edu/wiki/Codereview [KIT1]:  Code Review]
 == Literatur ==
@@ Zeile 34: / Zeile 58: @@
 * 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.: [https://svn.hshl.de/svn/MTR_SDE_Praktikum/trunk/Testdokumente/CodeReviews/D08-QM-3-Prozesse-Code-Reviews-und-Dokumentationsqualitaet.pdf 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|Seminar SDE WS 19/20]]