A metric for software readability
Raymond P.L. Buse, Westley R. Weimer · International Symposium on Software Testing and Analysis · 2008
In this paper, we explore the concept of code readability and investigate its relation to software quality. With data collected from 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% effective, and better than a human on average, at predicting readability judgments. Furthermore, we show that this metric correlates strongly with two traditional measures of software quality, code changes and defect reports. Finally, we discuss the implications of this study on programming language design and engineering practice. For example, our data suggests that comments, in of themselves, are less important than simple blank lines to local judgments of readability.
Cited by 182 works. doi:10.1145/1390630.1390647
Authors
References
- A Discipline of Programming
- The Mythical Man-Month
- 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 mythical man-month: essays on software engineering
- The Technique of Clear Writing.
- SMOG Grading - A New Readability Formula.