Not logged in.

Quick Search - Contribution

Contribution Details

Type Bachelor's Thesis
Scope Discipline-based scholarship
Title Investigation of Python Documentation Comments in Open-Source Projects
Organization Unit
Authors
  • Matej Jakovljevic
Supervisors
  • Harald Gall
  • Sebastian Proksch
Language
  • English
Institution University of Zurich
Faculty Faculty of Business, Economics and Informatics
Date 2019
Abstract Text Source code comments are ubiquitous in the field of software engineering. Developers use them to describe their intentions and improve the comprehensibility of the associated source code. The reusability of existing source code increases the importance of documentations comments, which provide information about the reused source code entity to end-users. However, the benefits of comments heavily depend on their content. To help developers write comments, and thus add value to the them, it is necessary to understand what content they usually contain and how they are structured. Since this has not been explored deeply for documentation comments in Python yet, this thesis provides a basis for future researchers by investigating whether Python documentation comments in open-source projects follow a particular syntax, and what content they contain. Our investigation revealed that most Python documentation comments in open-source projects contain only one line of text, and that more than every third comment that contains more than one line of text follows a certain syntax. Our empirical study on the contents of documentation comments showed that a general description of the documented source code element is dominant, but descriptions of parameters and return values are also common to occur.
Zusammenfassung Quellcode Kommentare sind allgegenwärtig im Bereich der Software-Entwicklung. Entwickler benutzen diese, um ihre Absichten zu beschreiben und die Verständlichkeit des dazugehörigen Quellcodes zu verbessern. Durch dieWiederverwendbarkeit von bereits bestehendem Quellcode haben dokumentations Kommentaren, die dem Benutzer Informationen über den beschriebenen Quellcode zur Verfügung stellen, an Bedeutsamkeit gewonnen. Dennoch hängen die Vorteile, die Kommentare mit sich bringen, stark von deren Inhalt ab. Um Entwickler beim Schreiben von Kommentaren zu unterstützen, und somit einen Mehrwert der Kommentare zu generieren, ist es notwendig zu verstehen, welchen Inhalt diese normalerweise mit sich bringen und wie sie strukturiert sind. Da dies für dokumentations Kommentare in Python noch nicht tiefgründig untersucht wurde, stellt diese Arbeit eine erste Grundlage für zukünftige Forscher, indem wir untersuchen, ob Python dokumentations Kommentare in Open-Source Projekten einer bestimmten Syntax folgen, und welche Inhalte in den Kommentaren vorkommen. Unsere Untersuchungen haben gezeigt, dass die meisten Python dokumentations Kommentare in Open-Source Projekten nur eine Textzeile enthalten und das mehr als jeder dritte Kommentar, der mehr als eine Zeile Text enthält, einer gewissen Syntax folgt. Eine empirische Studie über die Inhalte hat ergeben, dass eine generelle Beschreibung des dokumentierten Quellcode Elements dominant ist, jedoch auch Beschreibungen von Parametern und Rückgabewert häufig zu finden sind.
PDF File Download
Export BibTeX