我可以用Eclipse轻松地将javadoc添加到包中吗?

4年后更新(2013年10月)

javabeangrinder 的 answer (投赞成票)提到以下技巧:

创建一个 package-info.java 现有包中的文件:

• 右键单击您想要的包 包-info.java .
• 选择 new->package .
• 检查 Create package.info.java 复选框。
• 点击 Finish

原始答案(2009年5月)

没有模板或向导可以轻松创建package.html文件。

AS mmyers 在他的评论中说,自从 Java1.5 ,要创建的正确文件将是 package-info.java .
该文件不仅可以用于javadocs,还可以用于 package-level annotations (AS) illustrated here )

有一个 opened Bug (#86168) 要求巫师创造 包-info.java (自 类向导不允许 package-info 名称 )

关于那个话题的思考是从…2005!问题是任何解决方案都应该 以同样有助于 1.4 代码。

当前的解决方法是创建 包-info.java 作为一个 text 文件。
从这一点开始, 包-info.java 行为作为一个普通的Java类,而Eclipse放置一个 package-info.class 输出文件夹中的文件。
这个 Javadocs 正确构建使用 包-info.java 而不是 package.html 文件。

alt text http://jmdoudoux.developpez.com/cours/developpons/java/images/jaxb006.png

注(响应 Strawberry 的评论):

• bug 77451 (2004!,对于package.html)
• bug 163633 和 bug 163926 (2006,包信息。Java)

二者都 希望 一 在javadoc的package-info.java中预览包概述 看法 .

到目前为止,还没有提议/实施任何补丁。
对于要添加的功能,没有足够的需求。

日蚀

由于package-info.java不是类的有效标识符,因此不能在Eclipse中将其创建为类。

我发现当您创建一个新包时,会有一个复选框来检查您是否需要package-info.java。

要在现有包中创建package-info.java文件,请执行以下操作:

1. 右键单击需要package-info.java的包。
2. 选择“新建”->包。
3. 选中创建package.info.java复选框。
4. 点击完成

这个 JutoDOC 插件在这方面做得很好,以及您的所有其他文档需求。安装并配置插件,右键单击包并单击 jautodoc>添加包javadoc

有配置和模板可用于 .java 或 .html 包装文件。

这个插件还可以很好地实现JavaDoc所需的标准化,并进行大量的定制。

http://jautodoc.sourceforge.net/

有一个插件似乎可以创建package.html文件。我没用过,但有人在这里着陆可能会发现它有用。

http://sourceforge.net/projects/package-javadoc/