| |
| Acadêmico(a): Vilmar Orsi |
| Título: Gerador de Documentação para Linguagem C, Utilizando Templates |
| |
| Conclusão: |
| Da análise dos problemas envolvendo a questão da documentação de software, surgiu a idéia do desenvolvimento do GDC, uma ferramenta para a geração automática de documentação a partir do código fonte de programas escritos em C. O desenvolvimento da referida ferramenta voltou-se à geração de documentos de qualidade, que possam auxiliar no processo de implementação, manutenção e adaptação de software. O GDC faz uso de marcações especiais, dentro dos comentários de blocos, e gera a documentação no formato HTML, com as informações dispostas conforme estabelecido pelo usuário quando da elaboração do modelo de templates para os referidos documentos. Para códigos fonte não comentados, é possível gerar documentação com características básicas dos mesmos, tais como declaração de variáveis, cabeçalho de procedimentos e de funções. Quando da utilização de comentários, são gerados documentos mais complexos a partir dos referidos marcadores especiais, que são usados para delimitar informações como autor, data ou versão do código fonte. As informações necessárias para gerar documentação são extraídas dos códigos fonte escritos em C através de três conjuntos de analisadores léxico, sintático e semântico, sendo um dos conjuntos para a análise e coleta de informações no código fonte dos programas em C, outro para os DocComments e o terceiro para os templates. Um quarto analisador léxico armazena em uma tabela de símbolos todos os tokens reconhecidos no código fonte analisado, incluindo os comentários. É importante frisar que os analisadores léxicos e sintáticos foram gerados pelo GALS, o que veio a reduzir significativamente o trabalho de implementação de tais módulos. A documentação gerada pode ser padronizada pelos usuários, através dos modelos de templates, que são utilizados para formatar as informações agrupadas durante as análises léxica, sintática e semântica. A utilização dos modelos de templates está vinculada à liberdade concedida ao usuário de selecionar quais informações e em que ordem devem ser apresentadas na documentação. Deve-se destacar que para alcançar o objetivo de utilizar templates para a geração da documentação, foi necessário especificar e implementar um motor de templates, visto que não foi encontrado nenhum motor que satisfizesse as necessidades do gerador. Heesch (2006) quando menciona o uso de templates, atribui a esta atividade o grau máximo de dificuldade dentre as funcionalidades que propõe que sejam implementadas para o Doxygen. Observa-se que, em adição aos objetivos propostos foram implementadas funcionalidades para inserção dos comandos da linguagem de templates nos modelos de templates e de DocComments nos códigos fonte a serem documentados, o que reduz a chance de erros na documentação de programas. Outro fator importante foi a avaliação realizada pelos acadêmicos da disciplina de Programação I, dos cursos de Ciências da Computação e Sistemas de Informação, ministradas pelo professor Maurício Capobianco Lopes, que possibilitou a verificação de possíveis erros e aumentou a confiabilidade no GDC. |
| |
|
