arrow
返回

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

delete2018-11-16
delete19
PRE
AI
S
Sebastian Nielebock *
D
Dariusz Krolikowski
J
Jacob Krüger
T
Thomas Leich
F
Frank Ortmeier
DOI:10.1007/s10664-018-9664-zdelete
delete原文链接
delete原文求助
delete分享
delete收藏
摘要

摘要

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.
Keyword:
Comments
Program comprehension
Empirical study
Documentation
Maintenance
AI总结

AI总结

对已上传原文的论文进行重点信息的提取,主要内容包括:简要概述、研究摘要、背景介绍、关键亮点、图文解析、展望与总结。

期刊

Empirical Software Engineering 封面图
Empirical Software Engineering
IF:
3.6
论文数:
2.0K
被引数:
5.3K

机构

O
Otto von Guericke University
学者数:
8.5K
论文数: 6.7K
被引数: 54
引用论文

引用论文

The anterior process of the malleus in extant Lagomorpha (Mammalia)
err2017-10-25
err0
PREAI
errWolfgang Maier; Adrian Tröscher; Irina Ruf
err分享
err收藏
Estimation of phase derivative from a single fringe pattern using Riesz transforms
err2017-04-12
err0
PREAI
errYassine Tounsi; Sara Zada; Desire Muhire; Ahmed Siari; Abdelkrim Nassim
err分享
err收藏
err分享
err收藏
An empirical study on the impact of static typing on software maintainability静态类型对软件可维护性影响的实证研究
err2013-12-11
err56
PREAI
errHanenberg, Stefan; Kleinschmager, Sebastian; Robbes, Romain; Tanter, Eric; Stefik, Andreas
err分享
err收藏
err分享
err收藏
学者 查看更多内容