| |
| Acadêmico(a): Vilmar Orsi |
| Título: Gerador de Documentação para Linguagem C, Utilizando Templates |
| |
| Introdução: |
| A evolução da indústria de software tem acompanhado de perto, senão de forma mais acelerada, a evolução da indústria tecnológica, auxiliando cada vez mais áreas no desenvolvimento de suas atividades. Como tudo que se produz, software também precisa de manutenção e adaptação. Para reduzir o tempo gasto em manutenção e adaptação, nada melhor que um software bem construído e documentado de forma correta. Neste ponto surge um problema: considerável parte dos programas escritos não é documentada corretamente em função de orçamento e prazos, entre outros fatores. Áece (2003) afirma que a criação de documentação é uma fase muito importante no desenvolvimento de um software e que esta fase é ignorada por muitos programadores, o que vem a dificultar bastante quando o projeto é utilizado por outros. Sant’Anna (2001) acrescenta que a maioria dos programas possui pouca documentação que em geral não reflete a realidade das atualizações feitas. Além do mais, os ambientes de programação não facilitam a geração de documentação. Souza, Anquetil e Oliveira (2004) dão ênfase à importância da documentação de software, destacando que vários estudos têm sido realizados para minimizar os problemas relacionados com esse assunto. Segundo Sowek (2003), deve-se também considerar a documentação quanto ao seu conteúdo e qualidade, levando em conta a rapidez de acesso e disponibilidade da mesma. Sowek (2003) salienta ainda que não se deve esquecer a necessidade de uma atualização periódica da documentação, de acordo com as mudanças ocorridas, para que a mesma possa refletir a realidade. Nesse sentido, Tilley e Müller (1991 apud SOUZA; ANQUETIL; OLIVEIRA, 2004) “propuseram combinar documentação e código fonte de uma maneira fácil e eficiente, utilizando ferramenta de hipertexto”. Tentando resolver parte deste problema, surgiu a idéia de desenvolver uma ferramenta que automatizasse a documentação de software, a partir da análise dos códigos fonte dos programas, assim como dos comentários encontrados nos mesmos. Comentários bem elaborados, com marcações indicando autoria, funcionalidades, entre outras características, podem ser convertidos em documentos que além de auxiliarem na reutilização de código, servem como ponto de apoio quando se fizer necessária manutenção ou adaptação de alguma das funcionalidades do software. Algumas linguagens de programação, como Java e C# por exemplo, já contam com ferramentas com características semelhantes. Sendo assim, optou-se por desenvolver um gerador de documentação para a linguagem C, com o intuito de aplicação no meio acadêmico, objetivando desenvolver nos “potenciais programadores” o hábito de documentarem seus códigos fonte. A escolha do C se deu pelo fato de a referida linguagem ser utilizada na disciplina de Programação I do curso de Ciências da Computação da FURB, instituição onde foi viabilizado o uso do gerador de documentação pelos acadêmicos. Na ferramenta proposta, a documentação é gerada a partir dos códigos fonte de programas desenvolvidos na linguagem C. Tais códigos são analisados léxica e sintaticamente, tendo informações extraídas tanto das linhas de código, quanto dos comentários especiais (DocComments) dispostos nos mesmos. Para os códigos fonte não comentados são gerados documentos simples e para os comentados, documentos complexos. As informações, após ordenadas e modeladas, de acordo com o template desenvolvido e/ou selecionado pelo usuário, são apresentadas através de um conjunto de arquivos no formato HTML, compondo a documentação do software. |
| |
|
