The Computer Journal
Program evolution: processes of software change
Program evolution: processes of software change
Toward principles for the design of ontologies used for knowledge sharing
International Journal of Human-Computer Studies - Special issue: the role of formal ontology in the information technology
API documentation from source code comments: a case study of Javadoc
SIGDOC '99 Proceedings of the 17th annual international conference on Computer documentation
IJCAR '01 Proceedings of the First International Joint Conference on Automated Reasoning
Learning XML
Ontology Learning and Population from Text: Algorithms, Evaluation and Applications
Ontology Learning and Population from Text: Algorithms, Evaluation and Applications
The Description Logic Handbook
The Description Logic Handbook
Pellet: A practical OWL-DL reasoner
Web Semantics: Science, Services and Agents on the World Wide Web
/*icomment: bugs or bad comments?*/
Proceedings of twenty-first ACM SIGOPS symposium on Operating systems principles
How documentation evolves over time
Ninth international workshop on Principles of software evolution: in conjunction with the 6th ESEC/FSE joint meeting
A metric for software readability
ISSTA '08 Proceedings of the 2008 international symposium on Software testing and analysis
Exploring Regularity in Source Code: Software Science and Zipf's Law
WCRE '08 Proceedings of the 2008 15th Working Conference on Reverse Engineering
Semantic Assistants --- User-Centric Natural Language Processing Services for Desktop Clients
ASWC '08 Proceedings of the 3rd Asian Semantic Web Conference on The Semantic Web
Analyzing the Evolution of the Source Code Vocabulary
CSMR '09 Proceedings of the 2009 European Conference on Software Maintenance and Reengineering
Listening to programmers Taxonomies and characteristics of comments in operating system code
ICSE '09 Proceedings of the 31st International Conference on Software Engineering
Development of a Software Engineering Ontology for Multisite Software Development
IEEE Transactions on Knowledge and Data Engineering
Canadian AI'11 Proceedings of the 24th Canadian conference on Advances in artificial intelligence
Text Processing with GATE
FaCT++ description logic reasoner: system description
IJCAR'06 Proceedings of the Third international joint conference on Automated Reasoning
| Hi-index | 0.00 |
An important software engineering artifact used by developers and maintainers to assist in software comprehension and maintenance is source code documentation. It provides the insight needed by software engineers when performing a task, and therefore ensuring the quality of this documentation is extremely important. In-line documentation is at the forefront of explaining a programmer's original intentions for a given implementation. Since this documentation is written in natural language, ensuring its quality so far needed to be performed manually. In this paper, we present an effective and automated approach for assessing the quality of in-line documentation using a set of heuristics, targeting both the quality of language and consistency between the source code and its comments. Our evaluation is made up of two parts: We first apply the JavadocMiner tool to the different modules of two open source applications (ArgoUML and Eclipse) in order to automatically assess their intrinsic comment quality. In the second part of our evaluation, we correlate the results returned by the analysis with bug defects reported for the individual modules in order to examine connections between natural language documentation and source code quality.