Classifying Code Comments in Java Open-Source Software Systems
Authors:
- Luca PascarellaLPLuca Pascarella
- Alberto BacchelliABAlberto Bacchelli
Open Access
- 1 May 2017
- conference paper
- Published by Institute of Electrical and Electronics Engineers (IEEE)
- p. 227-237
Abstract
Code comments are a key software component containing information about the underlying implementation. Several studies have shown that code comments enhance the readability of the code. Nevertheless, not all the comments have the same goal and target audience. In this paper, we investigate how six diverse Java OSS projects use code comments, with the aim of understanding their purpose. Through our analysis, we produce a taxonomy of source code comments, subsequently, we investigate how often each category occur by manually classifying more than 2,000 code comments from the aforementioned projects. In addition, we conduct an initial evaluation on how to automatically classify code comments at line level into our taxonomy using machine learning, initial results are promising and suggest that an accurate classification is within reach.Keywords
This publication has 19 references indexed in Scilit:
- Towards automatically generating summary comments for Java methods2010
- /*icommentACM SIGOPS Operating Systems Review, 2007
- Empowering Software Maintainers with Semantic Web Technologies2007
- Examining the evolution of code comments in PostgreSQL2006
- Five Misunderstandings About Case-Study ResearchQualitative Inquiry, 2006
- A study of the documentation essential to software maintenance2005
- Metrics for assessing a software system's maintainability2003
- Machine learning in automated text categorizationACM Computing Surveys, 2002
- Code quality analysis in open source software developmentInformation Systems Journal, 2002
- Program readability: procedures versus commentsIEEE Transactions on Software Engineering, 1988