ti-enxame.com

Javadoc: package.html ou package-info.java

Ao tentar criar comentários do Javadoc em nível de pacote, qual é o método preferencial? O que você faz?

package-info.Java

  • Prós
    • Mais recente
  • Contras
    • Abuso de uma classe - Classes são para código, não apenas para comentários

package.html

  • Prós
    • Extensão HTML significa que não é código
    • Sintaxe destacada nos editores de texto/IDE
  • Contras
    • Nenhum?

Para mim, sempre usei Package.html. Mas eu estou querendo saber se é a escolha correta.

222
TheLQ

package-info.Java: "Este arquivo é novo no JDK 5.0 e é preferível ao invés de package.html." -- javadoc - O Java Gerador de Documentação da API

Adenda: A grande diferença parece ser anotações de pacotes . Há um pouco mais na maneira de raciocinar em 7.4 Declarações de Pacote .

Adendo: O recurso de anotação também é mencionado aqui e aqui .

Adendo: veja também O que é package-info.Java para? .

265
trashgod