如何用Java文档包？

182

在Java API中，我可以看到软件包的Javadoc注释。

如何/在何处放置Javadoc注释来记录软件包？

java packages javadoc

— 金吉
source

257

从1.5开始，您可以定义package-info.java文件并为包提供标准的javadoc样式注释：

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

— 加雷斯·戴维斯（Gareth Davis）
source

3

指向规范的直接链接：docs.oracle.com/javase/specs/jls/se7/html/jls-7.html#jls-7.4.1

— Givenkoa 2012年

7

在intellij中，您可以右键单击一个包，然后在新文件菜单下创建该包的选项

— bsautner

我发现文件必须位于packagename / src / packagename（以及其余的源文件）中

— trindflo

48

如其他答案所述，在Java 1.4之前（包括Java 1.4），您必须提供一个HTML文件package.html。

从Java 1.5开始，您还可以提供一个package-info.java，其中包含常规Javadoc注释（无HTML）。首选后者，因为它为您提供了一些额外的功能（特别是程序包注释）。

— 斯莱斯克
source

2

+1表示两种方式，以及两者之间的本质区别。顺便说一下，至少IntelliJ IDEA当前对package.html有更好的支持（包名称上的Ctrl-Q显示包Javadocs）。

— 约尼克，

3

更新至我之前的评论：如今，IDEA支持package-info.java得很好。

— 尼克，

4

package.html在包级别具有文件（即在该包的目录中）。这应该是一个完整的HTML文件，其中包含<html>定义的标签

— oxbow_lakes
source

1

更多细节？该文件应该是什么样？

— jjnguy

1

这是一个HTML文件，其中包含您的包裹的描述。而已！

— oxbow_lakes，2009年

3

这是老方法。从Java 1.5开始，您可以使用package-info.java

— k2col 2013年