A Study of Different Coding Styles Affecting Code Readability

Lee, Jung Been; Lee, Taek

doi:10.14257/ijseia.2013.7.5.36

Cited by 14 publications

(6 citation statements)

References 7 publications

Supporting

Mentioning

Contrasting

Order By: Relevance

“…Style guides are guidelines that dictate how code should be represented. From syntax elements to naming conventions, they ensure that code is as readable as possible for programmers [13], [14], eventually facilitating maintenance [15], [6]. While code convention adherence is perceived as important by practitioners [16], it is difficult for developers to comply [15], [17].…”

Section: Bmentioning

confidence: 99%

Python Coding Style Compliance on Stack Overflow

Bafatakis

Boecker

Boon

et al. 2019

2019 IEEE/ACM 16th International Conference on Mining Software Repositories (MSR)

View full text Add to dashboard Cite

Software developers all over the world use Stack Overflow (SO) to interact and exchange code snippets. Research also uses SO to harvest code snippets for use with recommendation systems. However, previous work has shown that code on SO may have quality issues, such as security or license problems. We analyse Python code on SO to determine its coding style compliance. From 1,962,535 code snippets tagged with 'python', we extracted 407,097 snippets of at least 6 statements of Python code. Surprisingly, 93.87% of the extracted snippets contain style violations, with an average of 0.7 violations per statement and a huge number of snippets with a considerably higher ratio. Researchers and developers should, therefore, be aware that code snippets on SO may not representative of good coding style. Furthermore, while user reputation seems to be unrelated to coding style compliance, for posts with vote scores in the range between-10 and 20, we found a strong correlation (r = −0.87, p < 10 −7) between the vote score a post received and the average number of violations per statement for snippets in such posts.

show abstract

Section: Bmentioning

confidence: 99%

Python Coding Style Compliance on Stack Overflow

Bafatakis

Boecker

Boon

et al. 2019

2019 IEEE/ACM 16th International Conference on Mining Software Repositories (MSR)

View full text Add to dashboard Cite

show abstract

“…A [21], R [33], T [35] and U [36] share some similarities with the first cluster of works. Although they do not intend to propose a metric for measuring the source code readability/comprehensibility, they try to identify, from a big list of source code measures, those that have some influence on the reading and comprehension of source code.…”

Section: Source Code Attributes Impacting Readability and Comprehensimentioning

confidence: 77%

Attributes Influencing the Reading and Comprehension of Source Code – Discussing Contradictory Evidence

Ribeiro

Travassos

2018

CLEIej

View full text Add to dashboard Cite

Background: Coding guidelines can be contradictory despite their intention of providing a universal perspective on source code quality. For instance, five attributes (code size, semantic complexity, internal documentation, layout style, and identifier length) out of 13 presented contradictions regarding their influence (positive or negative) on the source code readability and comprehensibility. Aims: To investigate source code attributes and their influence on readability and comprehensibility. Method: A literature review was used to identify source code attributes impacting the source code reading and comprehension, and an empirical study was performed to support the assessment of four attributes that presented empirical contradictions in the technical literature. Results: Regardless participants’ experience; all participants showed more positive comprehensibility perceptions for Python snippets with more lines of code. However, their readability perceptions regarding code size were contradictory. The less experienced participants preferred more lines of code while the more experienced ones preferred fewer lines of code. Long and complete-word identifiers presented better readability and comprehensibility according to both novices and experts. Comments contribute to better comprehension. Furthermore, four indentation spaces dominated the code reading preference. Conclusions: Coding guidelines contradictions still demand further investigation to provide indications on possible confounding factors explaining some of the inconclusive results.

show abstract

“…Lee et al 8 analyzed how the readability of code is affected by coding violations. While their study is useful in evaluating violations from the perspective of code readability, the work missed change history of violations over time.…”

Section: Related Workmentioning

confidence: 99%

An Evaluation of Coding Violation Focusing on Change History and Authorship of Source File

Burhandenny¹,

Aman²,

Kawahara³

2017

IJNDC

View full text Add to dashboard Cite

This paper focuses on an evaluation of coding violation warned by a static code analysis tool while considering the change history of violation and the authorship of source file. Through an empirical study with data collected from seven open source software projects, the following findings are reported: (1) the variety and the evaluation of a coding violation tend to vary accroding to the authoring type of the source file; (2) while important violations tend to vary from project to project, about 30% of violations are commonly disregarded by many programmers.

show abstract

A Study of Different Coding Styles Affecting Code Readability

Abstract: Abstract

Cited by 14 publications

References 7 publications

Python Coding Style Compliance on Stack Overflow

Python Coding Style Compliance on Stack Overflow

Attributes Influencing the Reading and Comprehension of Source Code – Discussing Contradictory Evidence

An Evaluation of Coding Violation Focusing on Change History and Authorship of Source File

Contact Info

Product

Resources

About