|
Title:
|
SOURCE CODE DOCUMENTATION: A TOOL FOCUSED ON BUSINESS REQUIREMENTS |
|
Author(s):
|
Humberto Ferreira da Luz Junior, Rodolfo Miranda de Barros |
|
ISBN:
|
978-989-8533-14-2 |
|
Editors:
|
Hans Weghorn and Pedro Isaías |
|
Year:
|
2012 |
|
Edition:
|
Single |
|
Keywords:
|
Source code documentation, requirements engineering, javadoc, documentation generator. |
|
Type:
|
Full Paper |
|
First Page:
|
267 |
|
Last Page:
|
274 |
|
Language:
|
English |
|
Cover:
|
|
|
Full Contents:
|
click to dowload 
|
|
Paper Abstract:
|
Aiming to fill a gap in traditional methods of source code documentation, which focus mainly on the API documentation for other programmers, this article presents a new approach for business requirements, mapping them through a set of annotations. These annotations, in turn, interpreted by the GaiaDoc tool, that is specified in this paper and is able to generate documentation in form of use case specifications in a language and format easily understandable by the project stakeholders. A case study of the proposed methodologys application is presented before the final considerations. |
|
|
|
|
|
|
