Not logged in.

Quick Search - Contribution

Contribution Details

Type Bachelor's Thesis
Scope Discipline-based scholarship
Title Generating Documentation to Reflect Side Effects of Methods
Organization Unit
Authors
  • Sandro Wirth
Supervisors
  • Harald Gall
  • Jürgen Cito
  • Gerald Schermann
Language
  • English
Institution University of Zurich
Faculty Faculty of Business, Economics and Informatics
Date 2018
Abstract Text Studies have shown that reducing side effects in software projects has a variety of advantages. It has a positive impact on testability, code comprehension, verifiability or performing refactorings. Although there are existing studies about detecting purity and side effects there is no study about. This thesis presents an approach on automatically showing the purity and side effects of Java methods during the workflow of reading and writing code to evaluate a positive influence on code comprehension. It is based on the implementation of a prototype that uses purity information from existing tools and transforms the information into readable Javadoc. To measure the influence on code comprehension, this thesis presents an evaluation of the implemented prototype by executing a quantitative empirical study with 14 participants. The results show that having the information can improve code comprehension for certain cases but also small details can lead to possible negative influences.
Zusammenfassung Studien haben gezeigt, dass die Reduktion von Seiteneffekte in Software Projekten eine Vielzahl an Vorteilen mit sich bringt. Es hat einen positiven Einfluss auf beispielsweise die Testbarkeit, das Code-Verständnis, die Verifizierbarkeit oder das Durchführen von Refactorings. Diese Arbeit präsentiert einen Ansatz, um automatisch das Vorhandensein beziehungsweise das Nicht-Vorhandensein von Seiteneffekten in Java Methoden während dem Lesen und Schreiben von Code anzuzeigen, mit dem Ziel zu prüfen, ob diese Information einen positiven Einfluss auf das Code Verständnis hat. Dazu wurde ein Prototyp entwickelt, der die Informationen über Seiteneffekten von existierenden Tools verwendet, verarbeitet und in lesbare Dokumentation umwandelt in der Form von Javadoc. Um den Einfluss auf das Code Verständnis zu messen, präsentiert diese Arbeit eine Evaluation des Prototypes anhand einer quantitativen, empirischen Studie mit 14 Teilnehmern. Die Resultate zeigen, dass das Vorhandensein dieser Information das Code Verständnis in gewissen Fällen erhöhen können, wobei kleine Details auch das Gegenteil bewirken können.
PDF File Download
Export BibTeX