Journal of Computer Science

COMENTE+: A TOOL FOR IMPROVING SOURCE CODE DOCUMENTATION USING INFORMATION RETRIEVAL

Julio Cezar Zanoni, Milton Pires Ramos, Cesar Augusto Tacla, Gilson Yukio Sato, Gregory Moro Puppi Wanderley and Emerson Cabrera Paraiso

DOI : 10.3844/jcssp.2014.755.762

Journal of Computer Science

Volume 10, Issue 5

Pages 755-762

Abstract

Document source code is seen as a boring time consuming task by several developers. However, a well-documented source code, allow developers to have a better visibility into what was and is being developed, helping, for example, the reuse of the code. This study presents a semi-automatic method for documentation of source code from the existing artifacts in a software project under development. The method aims to reduce developer’s workload, allowing them to work on other tasks of the project and/or ensure that the project deadlines will be met. The method, implemented in a tool, called Comente+, is capable of creating or updating comments into a source code from gathered information recovered from the project artifacts. To implement Comente+, we used an information retrieval approach. We performed some experiments with real data to validate this approach. For that, we created a special measure that estimates how well documented a source code is.

Copyright

© 2014 Julio Cezar Zanoni, Milton Pires Ramos, Cesar Augusto Tacla, Gilson Yukio Sato, Gregory Moro Puppi Wanderley and Emerson Cabrera Paraiso. This is an open access article distributed under the terms of the Creative Commons Attribution License, which permits unrestricted use, distribution, and reproduction in any medium, provided the original author and source are credited.