Bom, acho que todos vocês já devem ter desenvolvido muitos softwares com muitas linhas de código e em algum momento precisou apresentar isso documentado para alguém. Estamos falando da documentação do nosso trabalho. Nós temos o habito de codificar muitas coisas e depois não escrever nada sobre tudo aquilo que a gente fez, deixando os trabalhadores posteriores de mãos atadas.
Porém nos possuímos um aliado para criar a papelada do nosso software, eu apresento a vocês o Doxygen!
Doxygen é uma ferramenta de geração de documentação. Até agora um dos projetos mais geniais que eu já vi na minha vida. É mágico, e o melhor, você escreve no próprio código e ele já faz o trabalho para você. A melhor parte? Totalmente gratuita.
Ele entende uma variedade de comentários no código para gerar documentação, com algumas pequenas regras. Você pode gerar documentação para diversas coisas dentro de um arquivo, e ele gera toda a documentação em HTML e em Latex. De tal forma que você pode disponibilizar o html na sua página pessoal e imprimir o Latex para mostrar para as pessoa.
Ele é baseado na idéia do Javadoc, que vem da linguagem Java, porém funciona para uma porção de outras linguagens, um exemplo de documentação de função seria:
/**
* @brief Descrição curta
*
* Descrição Longa
*
* @param a
*
* See Outra
*/
function coisa(int a)
{
/* coisas */
}
O comentário interno foi só para explicitar que o seu código vai ali.
Essa é a estrutura de comentários para funções do Doxygen, você pode gerar anotações para os atributos de classes e estruturas.
E ele é esperto o suficiente para gerar árvore de hierarquia de classes!
Eu estou usando essa ferramenta e estou bastante satisfeito! Convido vocês programadores a tentar utilizá-la também.
Um abraco e até a próxima!
Nenhum comentário:
Postar um comentário