Geração Automática de Documentação a Partir de Código Fonte

• Christiano de Oliveira Braga PUC-Rio
• Marcelo Moreira PUC-Rio
• Arndt von Staa PUC-Rio

DOI: https://doi.org/10.5753/sbes.1997.24066

Abstract

Program documentation is fundamental for the production and evolution of quality software. After investigating several documentation tool proposals, we developed our own tool which addresses the main attributes of an ideal solution and generates an HTML hypertext. We implemented Documentu integrating the transformation system Draco-PUC and the software engineering environment Talisman. This latter provides a Text database with an ample and evolvable set of relations, and provides an internal data manipulation language which can be used to write validators and linearizers used to generate the HTML text.

Keywords: Documentation, transformation systems, CASE tools, software engineering, tool integration

References

Garg, P.K.; Scacchi, W.; "A Hypertext to Manage Software Life-Cycle Documents"; IEEE Software; May 1990; pp.90-98

Horowitz, E; Kemper, A.; Nagarasimham; "A Survey of Application Generation"; IEEE Computer; Vol. 18; n. 2 (Jan 1985); pp. 40-54

Leite, J.C. S.P.; Sant'anna M. ; Freitas, F. G.; "Draco-PUC : a Technology Assembly for Domain Oriented Software Development"; Proceedings of the 3rd IEEE International Conference of Software Reuse; 1994

Staa, A.v.; Ambiente de Engenharia de Software Talisman, Manual do Usuário; Rio de Janeiro; Staa Informática; 1993

Staa, A.v. et al "Regras e recomendações para a inclusão de especificações no código de programas C ou C++"; Monografias em Computação, Departamento de Informática, PUC-Rio