terça-feira, 1 de julho de 2008

Javadoc / pacotes

Como colocar comentários sobre os pacotes de classes Java via Javadoc?

Originalmente é possível fazer isso através de um arquivo package.html.

Mas também existe a opção de utilizar o arquivo "package-info.java". Este arquivo não deve conter uma classe, alias, esse nome é inválido para uma classe.

O arquivo .java deve conter, portanto, o nome do pacote e os comentários desejados.

A vantagem do arquvo .java é a não necessidade de lidar com a linaguem HTML.

Exemplo:

/**
Pacote principal que contém os demais pacotes do projeto.
@author RR
@version 1.0
*/
package br.com.rr;