Uso de Javadoc em projetos reais

5

Eu estou querendo saber se o Javadoc está usando em projetos reais, o que sua experiência diz sobre isso?

    
por Eugene 12.01.2011 / 21:46
fonte

4 respostas

5

Eu uso isso o tempo todo. É útil para mim porque é exibido no meu IDE enquanto digito '.' para uma chamada de método ou quando eu passar o mouse sobre uma chamada ou classe. É muito mais fácil e rápido do que clicar em um elemento e ler o código-fonte para determinar o que uma chamada no mundo faz. Em seu papel pretendido como uma ferramenta de documentação da API, ela brilha.

Normalmente, não uso a documentação da Web gerada durante a codificação; no entanto, se eu estiver tentando obter uma visão geral de um projeto (hierarquias, escopos etc.), posso gerá-lo.

Eu javadoc todos os membros públicos, e encorajo-vos a fazer o mesmo. Apenas tenha em mente que o fato de a documentação estar lá não significa que seja bom. Isso é com você.

    
por 12.01.2011 / 22:08
fonte
2

O JavaDoc é usado rotineiramente, mas:

1) Nem sempre completo

2) Muitas vezes não é mantido atualizado com o código

3) Mesmo quando presente, nem sempre é lido.

A última é uma questão muito séria: se algo não é óbvio a partir da assinatura (por exemplo, uma surpresa, suposição, limitação, etc.), documentá-la não é suficiente porque é muito provável que ela não seja lida. (Veja minha discussão sobre este problema em (questão SO relacionada) )

    
por 27.04.2011 / 02:26
fonte
0

Achei divertido, mas não muito útil para o código normal. Se eu estivesse criando código para ser compartilhado, eu geraria os javadocs.

    
por 13.01.2011 / 02:01
fonte
0

Os Javadocs são tão bons quanto os comentários criados por eles; se os comentários não estiverem lá, ou atualizados, o javadoc traz pouco que o preenchimento automático não fará.

    
por 27.04.2011 / 01:30
fonte

Tags