Yukinao Hirata
ABSTRACT
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.
- P. Graham. Hackers and Painters: Big Ideas from the Computer Age, chapter 8, pages 121--129. O'Reilly Media, 2004.Google Scholar
- R. K. Lind and K. Vairavan. An experimental investigation of software metrics and their relationship to software development effort. IEEE Trans. Softw. Eng., 15(5):649--653, 1989. Google ScholarDigital Library
- O. Mizuno and T. Kikuno. Training on errors experiment to detect fault-prone software modules by spam filter. In Proc. of 6th joint meeting of the European software engineering conference and the ACM SIGSOFT symposium on the foundations of software engineering, pages 405--414, 2007. Google ScholarDigital Library
- J. Sliwerski, T. Zimmermann, and A. Zeller. When do changes induce fixes? (on Fridays.). In Proc. of 2nd International workshop on Mining software repositories, pages 24--28, 2005. Google ScholarDigital Library
- L. Tan, D. Yuan, G. Krishna, and Y. Zhou. /* iComment: bugs or bad comments? */. In Proc. of SOSP'07, 10 2007. Google ScholarDigital Library
Index Terms
- Do comments explain codes adequately?: investigation by text filtering
Recommendations
Comments-oriented blog summarization by sentence extraction
CIKM '07: Proceedings of the sixteenth ACM conference on Conference on information and knowledge managementMuch existing research on blogs focused on posts only, ignoring their comments. Our user study conducted on summarizing blog posts, however, showed that reading comments does change one's understanding about blog posts. In this research, we aim to ...
The Way We Program
Code lacking comments, meaningful identifiers, and correct indentation is a nightmare. By studying 30 programs of various sizes to measure what percentage of their source code consisted of comments, meaningful identifiers, and whitespace, the author ...
The politics of comments: predicting political orientation of news stories with commenters' sentiment patterns
CSCW '11: Proceedings of the ACM 2011 conference on Computer supported cooperative workPolitical views frequently conflict in the coverage of contentious political issues, potentially causing serious social problems. We present a novel social annotation analysis approach for identification of news articles' political orientation. The ...
Comments