Entwurf und Entwicklung eines Code-Review-Moduls zur Unterstützung des Review-Prozesses in integrierten Entwicklungsumgebungen

Abstract

Code-Reviews sind weit verbreitete Aktivitäten des Software-Qualitätsmanagements. Obwohl sie sich als sehr effektive Methoden zur Fehlerreduzierung bewährt haben, weisen diese manuellen, dokumentbasierten und zeitintensiven Prüfverfahren in der Praxis Defizite auf. Im Besonderen wird in dieser Arbeit auf Probleme eingegangen, die auf Defizite einer unzureichenden Planung und fehlender Standardisierung, auf Defizite bei der Verwaltung und Erstellung von Problemberichten und Review-Dokumenten sowie auf Defizite bei der Messung des Review-Prozesses, zurückzuführen sind.<br />Um diese Defizite zu reduzieren und damit die Effektivität der Reviews zu erhöhen, wird in dieser Arbeit ein Lösungskonzept für ein Code-Review-Modul, das den Review-Prozess in integrierten Entwicklungsumgebungen unterstützt, präsentiert. Integrierte Entwicklungs-umgebungen stellen hilfreiche Werkzeuge, als Komponenten unter einer Benutzeroberfläche vereint, zur Verfügung. Mit Hilfe dieser Werkzeuge, einem definierten Review-Prozess und verschiedener Rollen, basierend auf dem IEEE-Standard 1028-1997 für Software-Reviews, soll eine optimale Unterstützung gewährleistet und die identifizierten Defizite reduziert werden. Das Konzept sieht neben einer zentralen Verwaltung von Review-Daten auch die Möglichkeit der automatisierten Erstellung von Review-Dokumenten vor. Zusätzlich wird die Analyse des Review-Prozesses durch das Modul unterstützt, um Aussagen über die Effektivität der Reviews treffen zu können. Diese werden mit Hilfe einiger von Barnard et al. vorgeschlagenen Metriken ermittelt.<br />Basierend auf diesem Lösungskonzept wird anschließend eine prototypische Implementierung präsentiert. Hierfür wurden sämtliche Anforderungen des Konzepts als Erweiterung für die integrierte Entwicklungsumgebung Eclipse umgesetzt.<br />Zusammenfassend deuten entwicklungsbegleitende Ad-hoc-Evaluierungen auf eine potentielle Steigerung der Effektivität bei der Durchführung von Reviews hin. Eine kontrollierte empirische Studie, über das tatsächliche Ausmaß der Effektivität des Review-Prozesses, ist für die Zukunft geplant.<br />

Code reviews are powerful methods to reveal defects in program code, during the various phases of the software development process. As important reviews are for the quality of a product, as cost-intensive they are. For that reason the optimization of the review process becomes more and more important. Reports from various companies document deficits in implementing and executing time-consuming and documentation-centric review processes. This work specially goes into detail with problems caused by insufficient planning, nonexisting standardisation, managing data, creating reports and analyzing the review process.<br />To reduce deficits and increase efficiency in the review process, this work presents a concept for a code review module. The objective of this concept is to support a specific role-based review process in integrated development environments. By using helpful tools, provided by integrated development environments, and a specific role-based review process, based on the IEEE standard 1028-1997 for software reviews, this module should help to reduce the identified deficits and make reviews more effective. Additionally, this concept supports automatically creating review documents as well as analyzing the review process.<br />Based on the concept, this work presents a prototypical implementation of a code review module. The tool implements all requirements specified in the concept as a plug-in module for the popular Eclipse platform.<br />Results from early evaluations during implementation indicated potential increase in efficiency. Furthermore, empirical studies will be conducted to find out the real dimension of increase and to improve the handling of the plug-in module.<br />