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

Resumo

A produção de documentação de boa qualidade é uma tarefa crítica no processo de desenvolvimento de software. Após analisamos algumas propostas existentes, implementamos uma ferramenta, que suporta os principais conceitos encontrados nesta análise, gerando a documentação sob a forma de um hipertexto HTML. A ferramenta Documentu foi arquitetada e construída integrando o sistema transformacional Draco-PUC e o ambiente Talisman que provê uma base de fragmentos de textos e relações, além de uma linguagem de manipulação de dados que permite criar validadores e linearizadores utilizados para gerar o texto HTML.

Palavras-chave: Documentação, aplicação de sistemas transformacionais, ferramentas CASE, integração de ferramentas, engenharia de software

Referências

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