How Does Code Readability Change During Software Evolution?

Valentina Piantadosi, Fabiana Fierro, Simone Scalabrino, Alexander Serebrenik, Rocco Oliveto (Corresponding author)

Research output: Contribution to journalArticleAcademicpeer-review

1 Citation (Scopus)
8 Downloads (Pure)

Abstract

Code reading is one of the most frequent activities in software maintenance. Such an activity aims at acquiring information from the code and, thus, it is a prerequisite for program comprehension: developers need to read the source code they are going to modify before implementing changes. As the code changes, so does its readability; however, it is not clear yet how code readability changes during software evolution. To understand how code readability changes when software evolves, we studied the history of 25 open source systems. We modeled code readability evolution by defining four states in which a file can be at a certain point of time (non-existing, other-name, readable, and unreadable). We used the data gathered to infer the probability of transitioning from one state to another one. In addition, we also manually checked a significant sample of transitions to compute the performance of the state-of-the-art readability prediction model we used to calculate the transition probabilities. With this manual analysis, we found that the tool correctly classifies all the transitions in the majority of the cases, even if there is a loss of accuracy compared to the single-version readability estimation. Our results show that most of the source code files are created readable. Moreover, we observed that only a minority of the commits change the readability state. Finally, we manually carried out qualitative analysis to understand what makes code unreadable and what developers do to prevent this. Using our results we propose some guidelines (i) to reduce the risk of code readability erosion and (ii) to promote best practices that make code readable.
Original languageEnglish
Pages (from-to)5374-5412
Number of pages39
JournalEmpirical Software Engineering
Volume25
Issue number6
DOIs
Publication statusPublished - 1 Nov 2020

Keywords

  • Code readability
  • Mining software repositories
  • Software evolution

Fingerprint

Dive into the research topics of 'How Does Code Readability Change During Software Evolution?'. Together they form a unique fingerprint.

Cite this