Adherence of class comments to the commenting style guidelines


Coding style guidelines provide various conventions to write code or comments in a particular style. For example, according to Java Oracle style guidelines, a class comment should provide high-level overview such as one-line summary, author information written with @author annotation. However, how often developers follow these commenting guidelines in their class comments, is not explored. Additionally, these guidelines differ across organizations, projects, or programming languages. A recent study [Rani20a] in Pharo explored the commenting guidelines for class comment. They discovered that the class comment guidelines suggest to provide more detailed knowledge of the class, for example, intent of the class, important APIs, and instance variables the class has. They also found that Pharo developers follow commenting guidelines while writing class comments.Whether developers in other languages (Java, or Python) have the same behaviour or not, requires further analysis.

Potential RQs.

NB: The project is an extension to the previous-project, and the initial four steps mentioned in the previous project are already accomplished.


Further Material