Breadcrumb

 
 

Assessing The Quality Factors Found in In-Line Documentation Written in Natural Language: The JavadocMiner

Title:

Assessing The Quality Factors Found in In-Line Documentation Written in Natural Language: The JavadocMiner

Khamis, Ninus (2011) Assessing The Quality Factors Found in In-Line Documentation Written in Natural Language: The JavadocMiner. Masters thesis, Concordia University.

[img]PDF - Accepted Version
Restricted to Registered users only

2515Kb

Abstract

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 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 informal natural language, ensuring its quality needs to be performed manually. In this works, 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 source code and its comments. Our evaluation is made up of three 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. And
finally, we compare the comment quality results generated
using our JavadocMiner with the quality assessments performed manually by undergraduate and graduate computer science students.

Divisions:Concordia University > Faculty of Engineering and Computer Science > Computer Science and Software Engineering
Item Type:Thesis (Masters)
Authors:Khamis, Ninus
Institution:Concordia University
Degree Name:M.A. Sc.
Program:Software Engineering
Date:14 April 2011
Thesis Supervisor(s):Rilling, Juergen and Witte, René
ID Code:7300
Deposited By:NINUS KHAMIS
Deposited On:09 Jun 2011 10:46
Last Modified:18 Dec 2012 11:27
All items in Spectrum are protected by copyright, with all rights reserved. The use of items is governed by Spectrum's terms of access.

Repository Staff Only: item control page

Document Downloads

More statistics for this item...

Concordia University - Footer