Do Comments follow Commenting Conventions? A Case Study in Java and Python

08/24/2021
by   Pooja Rani, et al.
0

Assessing code comment quality is known to be a difficult problem. A number of coding style guidelines have been created with the aim to encourage writing of informative, readable, and consistent comments. However, it is not clear from the research to date which specific aspects of comments the guidelines cover (e.g., syntax, content, structure). Furthermore, the extent to which developers follow these guidelines while writing code comments is unknown. We analyze various style guidelines in Java and Python and uncover that the majority of them address more the content aspect of the comments rather than syntax or formatting, but when considering the different types of information developers embed in comments and the concerns they raise on various online platforms about the commenting practices, existing comment conventions are not yet specified clearly enough, nor do they adequately cover important concerns. We also analyze commenting practices of developers in diverse projects to see the extent to which they follow the guidelines. Our results highlight the mismatch between developer commenting practices and style guidelines, and provide several focal points for the design and improvement of comment quality checking tools.

READ FULL TEXT

page 1

page 2

page 3

page 4

research
08/17/2021

What Do Developers Discuss about Code Comments?

Code comments are important for program comprehension, development, and ...
research
05/23/2020

What do class comments tell us? An investigation of comment evolution and practices in Pharo

Previous studies have characterized code comments in different programmi...
research
02/18/2021

Speculative Analysis for Quality Assessment of Code Comments

Previous studies have shown that high-quality code comments assist devel...
research
08/25/2021

RepliComment: Identifying Clones in Code Comments

Code comments are the primary means to document implementation and facil...
research
12/05/2021

A comment-driven evidence appraisal approach for decision-making when only uncertain evidence available

Purpose: To explore whether comments could be used as an assistant tool ...
research
01/28/2021

Best Practices in Scientific Computing

The world is becoming increasingly complex, both in terms of the rich so...
research
02/17/2022

Designing Word Filter Tools for Creator-led Comment Moderation

Online social platforms centered around content creators often allow com...

Please sign up or login with your details

Forgot password? Click here to reset