The Computer Journal
Program evolution: processes of software change
Program evolution: processes of software change
API documentation from source code comments: a case study of Javadoc
SIGDOC '99 Proceedings of the 17th annual international conference on Computer documentation
How documentation evolves over time
Ninth international workshop on Principles of software evolution: in conjunction with the 6th ESEC/FSE joint meeting
Do Code and Comments Co-Evolve? On the Relation between Source Code and Comment Changes
WCRE '07 Proceedings of the 14th Working Conference on Reverse Engineering
A metric for software readability
ISSTA '08 Proceedings of the 2008 international symposium on Software testing and analysis
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
Canadian AI'11 Proceedings of the 24th Canadian conference on Advances in artificial intelligence
An approach for web service discoverability anti-pattern detection for journal of web engineering
Journal of Web Engineering
Hi-index | 0.00 |
An important software engineering artefact used by developers and maintainers to assist in software comprehension and maintenance is source code documentation. It provides insights that help software engineers to effectively perform their tasks, and therefore ensuring the quality of the documentation is extremely important. Inline 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 needs to be performed manually. In this paper, we present an effective and automated approach for assessing the quality of inline documentation using a set of heuristics, targeting both quality of language and consistency between source code and its comments. We apply our tool to the different modules of two open source applications (ArgoUML and Eclipse), and correlate the results returned by the analysis with bug defects reported for the individual modules in order to determine connections between documentation and code quality.