eclipse - 我可以使用 Eclipse 轻松地将 JavaDoc 添加到包中吗？

Question

我使用 javadoc 来记录我的类和方法。我也想在我的包中添加一些概述信息。我喜欢在输入 /**<Enter> 后 Eclipse 为每个类或方法创建匹配文档注释的 stub 。 。 Eclipse 是否有一种简单的方法来生成 package.html file ，也？

Answer 1

4年后更新(2013年10月)

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

To create a package-info.java file in an existing package:

• 右键单击您想要package-info.java的包。
• 选择新建->包。
• 选中创建 package.info.java 复选框。
• 点击完成

<小时/>

原始答案(2009 年 5 月)

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

如mmyers在他的评论中说，从 Java1.5 开始，要创建的正确文件是 package-info.java .
该文件不仅可用于 javadocs，还可用于 package-level annotations (如illustrated here)。

有一个opened Bug (#86168)要求使用向导来创建 package-info.java(因为类向导不允许 package-info 名称)。

自 2005 年以来，人们一直在思考这个话题!问题是任何解决方案都应该 以同样有助于 1.4 代码的方式实现。

当前的解决方法是创建一个 package-info.java 作为 text 文件。
从那时起，package-info.java 的行为就像普通的 Java 类一样，并且 Eclipse 将 package-info.class 文件放置在输出文件夹中。
Javadocs 是使用 package-info.java 而不是 package.html 文件正确构建的。

_{(来源:developpez.com)}

<小时/>

注意(回应 Strawberry 的评论):

• bug 77451 (2004 年!，对于 package.html)
• bug 163633和 bug 163926 (2006 年，针对 package-info.java)

都希望在Javadoc中的package-info.java中预览包概述 查看。

到目前为止，尚未提出/实现任何补丁。
根本没有足够的需求来添加该功能。