A documentação é algo necessário em qualquer projeto, mas sempre ficou em segundo plano, pois requer tempo para sua criação. Outro fator é que o documentador tem sempre que acompanhar a evolução do sistema, colocando a documentaçao em paralelo ao desenvolvimento, o que nem sempre é uma tarefa fácil, nos projeto com alteração constante.
Com o GASweb tentamos automatizar este procedimento minimizando ao máximo este trabalho.
O GASweb, gera a documentação de seu projeto, toda vez que é gerado os fontes do mesmo, ou seja, a documentaçao poderá estar sempre atualizada, refletindo as alterações que voce fizer em seu projeto.
Além disto, como ela é automatizada, não requer nenhum conhecimento especial, o que a torna uma prática normal.
Após gerar um projeto, o GASweb cria uma pasta chamada "Doc", e dentro dela são geradas os arquivos em formato "htm" e outros formatos, que podem ser abertos por qualquer navegador. Dentro da subpasta "Project" são geradas diversas páginas, detalhando cada modulo criado em seu sistema.
Ao abrir em um browse, este será o formato apresentado:
Gere um projeto, e veja a facilidade de uso deste recurso no GASweb.
Nas próximas postagens, mostraremos o uso de ferramentas de terceiros para gerar documentação do código gerado(projeto físico), das classes e demais modulos gerados pelo GASweb.