Sign inSubmit
computersciencejournal.org is not ours. This journal is published only at thescipub.com/jcs. Report a suspicious emailcomputersciencejournal.org is not ours · Report
ArticleMetrics
Research Article · Free to read · Published 4 January 2014

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

Julio Cezar Zanoni1, Milton Pires Ramos1, Cesar Augusto Tacla2, Gilson Yukio Sato2, Gregory Moro Puppi Wanderley3 & Emerson Cabrera Paraiso3

Journal of Computer Science, Volume 10, Issue 5, pp. 755–762 · doi.org/10.3844/jcssp.2014.755.762

7,446 accesses5,178 downloads0 citations (Crossref)Metrics
Cite Check for updates

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.

Licence and reuse

Free to read. This article carries the publisher’s copyright, as printed on it: © 2014 Science Publications. It is free to read; ask us before reusing it.

How to reuse this article

Responses (0)

Have a comment on this research? Sign in to respond. Responses are moderated and published with your name and affiliation; the authors are invited to reply. How we use your dataWrite a response

About this article

Cite this article

Zanoni, J. C., Ramos, M. P., Tacla, C. A., Sato, G. Y., Wanderley, G. M. P. & Paraiso, E. C. (2014). COMENTE+: A TOOL FOR IMPROVING SOURCE CODE DOCUMENTATION USING INFORMATION RETRIEVAL. Journal of Computer Science, 10(5), 755–762. https://doi.org/10.3844/jcssp.2014.755.762

Licence
© Science Publications
Issue
Volume 10, Issue 5
Policies
Editorial independenceUse of generative AIData availabilityAppeals and complaints
Version
Version of record
COMENTE+: A TOOL FOR IMPROVING SOURCE CODE DOCUMENTATION USING INFORMATION RETRIEVALJournal of Computer Science · Volume 10, Issue 5 · pp. 755–762 · © Science PublicationsDownload