Learning a Metric for Code Readability
Raymond P.L. Buse, Westley R. Weimer · IEEE Transactions on Software Engineering · 2009
In this paper, we explore the concept of code readability and investigate its relation to software quality. With data collected from 120 human annotators, we derive associations between a simple set of local code features and human notions of readability. Using those features, we construct an automated readability measure and show that it can be 80 percent effective and better than a human, on average, at predicting readability judgments. Furthermore, we show that this metric correlates strongly with three measures of software quality: code changes, automated defect reports, and defect log messages. We measure these correlations on over 2.2 million lines of code, as well as longitudinally, over many releases of selected projects. Finally, we discuss the implications of this study on programming language design and engineering practice. For example, our data suggest that comments, in and of themselves, are less important than simple blank lines to local judgments of readability.
Cited by 395 works. doi:10.1109/tse.2009.70
Authors
References
- A Discipline of Programming
- A Complexity Measure
- A Study of Cross-Validation and Bootstrap for Accuracy Estimation and Model Selection
- The Java Language Specification
- A technique for measurement of attitudes
- A new readability yardstick.
- No Silver Bullet Essence and Accidents of Software Engineering
- The Technique of Clear Writing.
- SMOG Grading - A New Readability Formula.
- A Comparison of Consensus, Consistency, and Measurement Approaches to Estimating Interrater Reliability