Comment lines in the software source code include descriptions of codes, usage of codes, copyrights, unused codes, comments, and so on. It is required for comments to explain the content of written code adequately, since the wrong description in the comment may causes further bug and confusion in maintenance.
In this paper, we try to clarify a research question: "In which projects do comments describe the code adequately?" To answer this question, we selected the group 1 of mining challenge and used data obtained from Eclipse and Netbeans. Since it is difficult to answer the above question directly, we define the distance between codes and comments. By utilizing the fault-prone module prediction technique, we can answer the alternative question from the data of two projects. The result shows that Eclipse project has relatively adequate comments.
[1]
Andreas Zeller,et al.
When do changes induce fixes?
,
2005,
ACM SIGSOFT Softw. Eng. Notes.
[2]
K. Vairavan,et al.
An Experimental Investigation of Software Metrics and Their Relationship to Software Development Effort
,
1989,
IEEE Trans. Software Eng..
[3]
Thomas Zimmermann,et al.
When do changes induce fixes? On Fridays
,
2005
.
[4]
Paul Graham.
Hackers and painters - big ideas from the computer age
,
2004
.
[5]
Yuanyuan Zhou,et al.
/*icomment: bugs or bad comments?*/
,
2007,
SOSP.
[6]
Osamu Mizuno,et al.
Training on errors experiment to detect fault-prone software modules by spam filter
,
2007,
ESEC-FSE '07.