Documentador de API

[dango]

Pessoal, desenvolvemos um método para documentar a API dos nossos sistemas que é praticamente idêntico ao modo como o JavaDoc funciona. Desenvolvemos o PRGDOC e estamos pensando que talvez possa ser útil para a comunidade e que talvez fosse uma boa idéia torná-lo um projeto open-source.

Se alguém tiver interesse e quiser saber como fica a documentação feita com o PRGDOC acesse http://www.base4.com.br/doc

A documentação é feita diretamente no fonte, em blocos de comentário imediamente antes da sentence (função, procedimento, #define, método, etc.) que se deseja documentar, por exemplo:

Código: Selecionar todos

/**
 *  Texto do corpo da documentação da função vai aqui.
 *  @param cNome CHARACTER O nome do cidadão.
 *  @return NUMERIC O saldo do cidadão.
 * 
 *  @see OUTRO.PRG#outraFuncao
 */
FUNCTION FooBar( cNome )
     ...

O que o pessoal acha?