Como documento pacotes em Java?

182

Nas APIs Java, posso ver comentários do Javadoc para pacotes.

Como / onde coloco comentários Javadoc para documentar um pacote?

java packages javadoc jjnguy
fonte

Respostas:

257

A partir da versão 1.5, você pode definir um package-info.javaarquivo e fornecer um comentário no estilo javadoc padrão para um pacote:

com / foo / package-info.java:

/**
 * com.foo is a group of bar utils for operating on foo things.
 */
package com.foo;

//rest of the file is empty

Especificação de idioma para pacotes

Gareth Davis
fonte
3
Link direto para spec: docs.oracle.com/javase/specs/jls/se7/html/jls-7.html#jls-7.4.1 #
gavenkoa
7
no IntelliJ você pode clique direito em um pacote ea opção para criar esta deve estar sob o novo menu arquivo
bsautner
Eu encontrei o arquivo necessário para a packagename / src / packagename (com o resto dos arquivos de origem)
trindflo
48

Até o Java 1.4, inclusive, você precisava fornecer um arquivo HTML package.html, conforme descrito nas outras respostas.

Desde o Java 1.5, você também pode fornecer um package-info.java, que contém um comentário Javadoc regular (sem HTML). O último é o preferido, pois fornece alguns recursos extras (principalmente anotações de pacotes).

Detalhes: documentos da Sun para javadoc

sleske
fonte
2
+1 por mencionar os dois lados e a diferença essencial entre eles. A propósito, pelo menos o IntelliJ IDEA atualmente possui melhor suporte para package.html (Ctrl-Q no nome de um pacote mostra o Javadocs do pacote).
Jonik
3
Atualize para o meu comentário anterior: atualmente o IDEA suporta package-info.javamuito bem.
28613 Jonik
4

Com um package.htmlarquivo no nível do pacote (ou seja, no diretório desse pacote). Este deve ser um HTMLarquivo totalmente formado , com a <html>tag definida nele

oxbow_lakes
fonte
1
Mais detalhes? Como deve ser o arquivo?
jjnguy
1
É um arquivo HTML que contém a descrição do seu pacote. É isso aí!
Oxbow_lakes 8/03/09
3
Esta é a maneira antiga de fazê-lo. De Java 1.5 em diante você pode usar package-info.java
k2col