A metric for software readability

ISSTA'08: Proceedings of the 2008 International Symposium on Software Testing and Analysis 2008

Volumn , Issue , 2008, Pages 121-130

  Buse, Raymond P L ^a   Weimer, Westley R ^a  

^a University of Virginia   (United States)

Author keywords

Code metrics; FindBugs; Machine learning; Program understanding; Software maintenance; Software readability

Indexed keywords

CODES (SYMBOLS); COMPUTER PROGRAMMING LANGUAGES; COMPUTER SOFTWARE MAINTENANCE; LEARNING SYSTEMS; SOFTWARE TESTING;

CODE METRICS; FINDBUGS; MACHINE LEARNING; PROGRAM UNDERSTANDING; SOFTWARE MAINTENANCE; SOFTWARE READABILITY;

COMPUTER SOFTWARE SELECTION AND EVALUATION;

EID: 57449117472     PISSN: None     EISSN: None     Source Type: Conference Proceeding    
DOI: 10.1145/1390630.1390647     Document Type: Conference Paper

References (44)

1. K. Aggarwal, Y. Singh, and J. K. Chhabra. An integrated measure of software maintainability. Reliability and Maintainability Symposium, 2002. Proceedings. Annual, pages 235-241, September 2002.
2. S. Ambler. Java coding standards. Softw. Dev., 5(8):67-71, 1997.
3. P. Anderson and T. Teitelbaum. Software inspection using codesurfer. WISE '01: Proceeding of the first workshop on inspection in software engineering, July 2001.
4. B. B. Bederson, B. Shneiderman, and M. Wattenberg. Ordered and quantum treemaps: Making effective use of 2d space to display hierarchies. ACM Trans. Graph., 21(4):833-854, 2002.
5. B. Boehm and V. R. Basili. Software defect reduction top 10 list. Computer, 34(1):135-137, 2001.
6. L. W. Cannon, R. A. Elliott, L. W. Kirchhoff, J. H. Miller, J. M. Milner, R. W. Mitze, E. P. Schan, N. O. Whittington, H. Spencer, D. Keppel, and M. Brader. Recommended C Style and Coding Standards: Revision 6.0. Specialized Systems Consultants, Inc., Seattle, Washington, June 1990.
7. T. J. Cheatham, J. P. Yoo, and N. J. Wahl. Software testing: a machine learning experiment. In CSC '95: Proceedings of the 1995 ACM 23rd annual conference on Computer science, pages 135-141, 1995.
8. T. Y. Chen, F.-C. Kuo, and R. Merkel. On the statistical properties of the f-measure. In QSIC'04: Fourth International Conference on Quality Software, pages 146-153, 2004.
9. T. Copeland. PMD Applied. Centennial Books, Alexandria, VA. USA, 2005.
10. E. W. Dijkstra. A Discipline of Programming. Prentice Hall PTR, 1976.
11. J. L. Elshoff and M. Marcotty. Improving computer program readability to aid modification. Commun. ACM, 25(8):512-521, 1982.
12. R. F. Flesch. A new readability yardstick. Journal of Applied Psychology, 32:221-233, 1948.
13. J. Frederick P. Brooks. No silver bullet: essence and accidents of software engineering. Computer, 20(4):10-19, 1987.
14. J. Frederick P. Brooks. The Mythical Man-Month: Essays on Software Engineering, 20th Anniversary Edition. Addison-Wesley Professional, August 1995.
15. A. Goncalves. Get acquainted with the new advanced features of junit 4. DevX, http://www.devx.com/Java/Article/31983, 2006.
16. J. Gosling, B. Joy, and G. L. Steele. The Java Language Specification. The Java Series. Addison-Wesley, Reading, MA, USA, 1996.
17. T. L. Graves, A. F. Karr, J. S. Marron, and H. Siy. Predicting fault incidence using software change history. IEEE Trans. Softw. Eng., 26(7):653-661, 2000.
18. R. Gunning. The Technique of Clear Writing. McGraw-Hill International Book Co, New York, 1952.
19. N. J. Haneef. Software documentation and readability: a proposed process improvement. SIGSOFT Softw. Eng. Notes, 23(3):75-77, 1998.
20. A. E. Hatzimanikatis, C. T. Tsalidis, and D. Christodoulakis. Measuring the readability and maintainability of hyperdocuments. Journal of Software Maintenance, 7(2):77-90, 1995.
21. G. Holmes, A. Donkin, and I. Witten. Weka: A machine learning workbench. Proceedings of the Second Australia and New Zealand Conference on Intelligent Information Systems, 1994.
22. D. Hovemeyer and W. Pugh. Finding bugs is easy. SIGPLAN Not., 39(12):92-106, 2004.
23. T. M. Khoshgoftaar, E. B. Allen, N. Goel, A. Nandi, and J. McMullan. Detection of software modules with high debug code churn in a very large legacy system. In ISSRE '96: Proceedings of the The Seventh International Symposium, on Software Reliability Engineering (ISSRE '96), page 364, Washington, DC, USA, 1996. IEEE Computer Society.
24. J. P. Kinciad and E. A. Smith. Derivation and validation of the automated readability index for use with technical materials. Human Factors, 12:457-464, 1970.
25. P. Knab, M. Pinzger, and A. Bernstein. Predicting defect densities in source code files with decision tree learners. In MSR '06: Proceedings of the 2006 international workshop on Mining software repositories, pages 119-125, 2006.
26. J. C. Knight and E. A. Myers. Phased inspections and their implementation. SIGSOFT Softw. Eng. Notes, 16(3):29-35, 1991.
27. R. Kohavi. A study of cross-validation and bootstrap for accuracy estimation and model selection. International Joint Conference on Artificial Intelligence, 14(2):1137-1145, 1995.
28. R. Likert. A technique for the measurement of attitudes. Archives of Psychology, 140:44-53, 1932.
29. J. Lionel E. Deimel. The uses of program reading. SIGCSE Bull., 17(2):5-14, 1985.
30. S. MacHaffie, R. McLeod, B. Roberts, P. Todd, and L. Anderson. A readability metric for computer-generated mathematics. Technical report, Saltire Software, http://www.saltire.com/equation.html, retrieved 2007.
31. G. H. McLaughlin. Smog grading - a new readability. Journal of Reading, May 1969.
32. R. J. Miara, J. A. Musselman, J. A. Navarro, and B. Shneiderman. Program indentation and comprehensibility. Commun. ACM, 26(ll):861-867, 1983.
33. T. Mitchell. Machine Learning. McGraw Hill, 1997.
34. N. Nagappan and T. Ball. Use of relative code churn measures to predict system defect density. In ICSE '05: Proceedings of the 27th international conference on Software engineering, pages 284-292, 2005.
35. C. V. Ramamoorthy and W.-T. Tsai. Advances in software engineering. Computer, 29(10):47-58, 1996.
36. D. R. Raymond. Reading source code. In GASCON '91: Proceedings of the 1991 conference of the Centre for Advanced Studies on Collaborative research, pages 3-16. IBM Press, 1991.
37. P. A. Relf. Tool assisted identifier naming for improved software readability: an empirical study. Empirical Software Engineering, 2005. 2005 International Symposium on, November 2005.
38. S. Rugaber. The use of domain knowledge in program understanding. Ann. Softw. Eng., 9(1-4):143-192, 2000.
39. C. Simonyi. Hungarian notation. MSDN Library, November 1999.
40. S. E. Stemler. A comparison of consensus, consistency, and measurement approaches to estimating interrater reliability. Practical Assessment, Research and Evaluation, 9(4), 2004.
41. H. Sutter and A. Alexandrescu. C++ Coding Standards: 101 Rules, Guidelines, and Best Practices. Addison-Wesley Professional, 2004.
42. T. Tenny. Program readability: Procedures versus comments. IEEE Trans. Softw. Eng., 14(9):1271-1279, 1988.
43. A. Watters, G. van Rossum, and J. C. Ahlstrom. Internet Programming with Python. MIS Press/Henry Holt publishers, New York, 1996.
44. E. J. Weyuker. Evaluating software complexity measures. IEEE Trans. Softw. Eng., 14(9):1357-1365, 1988.