Commenting source code: is it worth it for small programming tasks?

Sebastian Nielebock

doi:10.1007/s10664-018-9664-z

Return

Commenting source code: is it worth it for small programming tasks?

2018-11-16

PRE

Sebastian Nielebock *

DOI：10.1007/s10664-018-9664-z

Original

Original request for help

Save

Abstract

En 中文

Maintaining a program is a time-consuming and expensive task in software engineering. Consequently, several approaches have been proposed to improve the comprehensibility of source code. One of such approaches are comments in the code that enable developers to explain the program with their own words or predefined tags. Some empirical studies indicate benefits of comments in certain situations, while others find no benefits at all. Thus, the real effect of comments on software development remains uncertain. In this article, we describe an experiment in which 277 participants, mainly professional software developers, performed small programming tasks on differently commented code. Based on quantitative and qualitative feedback, we i) partly replicate previous studies, ii) investigate performances of differently experienced participants when confronted with varying types of comments, and iii) discuss the opinions of developers on comments. Our results indicate that comments seem to be considered more important in previous studies and by our participants than they are for small programming tasks. While other mechanisms, such as proper identifiers, are considered more helpful by our participants, they also emphasize the necessity of comments in certain situations.

Keywords:

Comments

Program comprehension

Empirical study

Documentation

Maintenance

AI Summary

Key information extracted from the uploaded paper, including a brief overview, abstract, background, key highlights, visual analysis, and future outlook.