Impacts of coding practices on readability

Several conventions and standards aim to improve maintainability of software code. However, low levels of code readability perceived by developers still represent a barrier to their daily work. In this paper, we describe a survey that assessed the impact of a set of Java coding practices on the readability perceived by software developers. While some practices promoted an enhancement of readability, others did not show statistically significant effects. Interestingly, one of the practices worsened the readability. Our results may help to identify coding conventions with a positive impact on readability and, thus, guide the creation of coding standards.

[1]  Mario Linares Vásquez,et al.  Improving code readability models with textual features , 2016, 2016 IEEE 24th International Conference on Program Comprehension (ICPC).

[2]  Nir Kshetri,et al.  Improving Open Source Software Maintenance , 2010, J. Comput. Inf. Syst..

[3]  Leon Moonen,et al.  Evaluating the relation between coding standard violations and faultswithin and across software versions , 2009, 2009 6th IEEE International Working Conference on Mining Software Repositories.

[4]  Premkumar T. Devanbu,et al.  Will They Like This? Evaluating Code Contributions with Language Models , 2015, 2015 IEEE/ACM 12th Working Conference on Mining Software Repositories.

[5]  R. Flesch.  A new readability yardstick. , 1948, The Journal of applied psychology.

[6]  Robert C. Martin.  Clean Code - a Handbook of Agile Software Craftsmanship , 2008 .

[7]  Jonathan Dorn.  A General Software Readability Model , 2012 .

[8]  Leon Moonen,et al.  Assessing the value of coding standards: An empirical study , 2008, 2008 IEEE International Conference on Software Maintenance.

[9]  X. Fang,et al.  Using a coding standard to improve program quality , 2001, Proceedings Second Asia-Pacific Conference on Quality Software.

[10]  E. Thorndike.  The Teacher's Word Book , 2007 .

[11]  Premkumar T. Devanbu,et al.  Open Borders? Immigration in Open Source Projects , 2007, Fourth International Workshop on Mining Software Repositories (MSR'07:ICSE Workshops 2007).

[12]  Steve McConnell,et al.  Code Complete, Second Edition , 2004 .

[13]  S. M. García,et al.  2014: , 2020, A Party for Lazarus.

[14]  Westley Weimer,et al.  Learning a Metric for Code Readability , 2010, IEEE Transactions on Software Engineering.

[15]  Premkumar T. Devanbu,et al.  A simpler model of software readability , 2011, MSR '11.

[16]  Xiaosong Li,et al.  Using Peer Review to Assess Coding Standards - A Case Study , 2006, Proceedings. Frontiers in Education. 36th Annual Conference.

[17]  Xiaosong Li,et al.  Effectively teaching coding standards in programming , 2005, SIGITE '05.

[18]  Eleni Stroulia,et al.  Maintainability and Source Code Conventions: An Analysis of Open Source Projects , 2011 .

[19]  Les Hatton,et al.  Safer C - developing software for high-integrity and safety-critical systems , 1995, McGrawHill international series in software engineering.

[20]  William H. DuBay.  The Classic Readability Studies. , 2007 .

[21]  Rodrigo Magalhães dos Santos,et al.  Impacts of Coding Practices on Readability , 2018, 2018 IEEE/ACM 26th International Conference on Program Comprehension (ICPC).