Towards Detecting Inconsistent Comments in Java Source Code Automatically

Stulova, Nataliia; Blasi, Arianna; Gorla, Alessandra; Nierstrasz, Oscar (2020). Towards Detecting Inconsistent Comments in Java Source Code Automatically. In: IEEE 20th International Working Conference on Source Code Analysis and Manipulation (SCAM 2020). 28 Sept.-2 Oct. 2020. 10.1109/SCAM51674.2020.00012

	Text Stul20b-InconsistentComments.pdf - Accepted Version Restricted to registered users only Available under License Publisher holds Copyright. Download (214kB)
	Text 09252010.pdf - Published Version Restricted to registered users only Available under License Publisher holds Copyright. Download (135kB)

A number of tools are available to software developers to check consistency of source code during software evolution. However, none of these tools checks for consistency of the documentation accompanying the code. As a result, code and documentation often diverge, hindering program comprehension. This leads to errors in how developers use source code, especially in the case of APIs of reusable libraries. We propose a technique and a tool, upDoc, to automatically detect code-comment inconsistency during code evolution. Our technique builds a map between the code and its documentation, ensuring that changes in the code match the changes in respective documentation parts. We conduct a preliminary evaluation using inconsistency examples from an existing dataset of Java open source projects, showing that upDoc can successfully detect them. We present a roadmap for the further development of the technique and its evaluation.

Interest & Impact

Downloads

2 since deposited on 20 Apr 2021
0 in the past 12 months

Citations

5 Citations in Web of Science ®
6 Citations in Scopus

Search

in Google Scholar™

Services

Actions (login required)

Edit item

Actions (login required)

Edit item