Documentação de Código

Desde há umas semanas que tenho andado a analisar o código de duas aplicações de dinâmica molecular bastante conhecidas, e largamente usadas, o NAMD e o GROMACS.

Tendo em conta a reputação das aplicações, seria de esperar uma documentação a condizer. Mas se ao nível da documentação para o utilizador, até esteja bastante completa, o mesmo não se pode dizer da documentação do código. Não encontrei um único documento que descrevesse os vários módulos que constituem a aplicação, nem que descrevesse quais as funcionalidades das várias funções. A única solução possível para perceber a aplicação é, assim, percorrer as centenas de ficheiros que a constituem. E mesmo percorrendo os ficheiros, continua a ser complicado perceber quais as funcionalidades que estes disponibilizam, pois os comentários no código não abundam…

Custa-me um pouco a perceber como é que aplicações desta dimensão têm uma documentação tão pobre…

Uma resposta

  1. Anonymous coward diz:

    É muito comum em projectos opensource.

Deixar uma resposta

O seu endereço de email não será publicado.