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

Question

我使用javadoc来记录我的类和方法。我也想在我的软件包中添加一些概述信息。我喜欢Eclipse在键入/**<Enter>后为每个类或方法创建匹配的Doc Comment的存根。 Eclipse也有一种简单的方法来生成package.html file吗？

Answer 1

4年后更新（2013年10月）

javabeangrinder的answer（upvoted）提到了以下技巧：

  

在现有包中创建package-info.java文件：

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

---

原始答案（2009年5月）

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

正如mmyers在评论中所述，自Java1.5以来，要创建的正确文件为package-info.java。 该文件不仅可用于javadoc，还可用于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！，for package.html）
• bug 163633和bug 163926（2006，for package-info.java）

希望 在Javadoc中的package-info.java中的预览包概述 图

到目前为止，尚未提出/实施补丁 对该功能的添加根本没有足够的要求。

Answer 2

在日食中

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

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

在现有包中创建package-info.java文件：

1. 右键单击要包含package-info.java的包。
2. 选择new-＆gt;包。
3. 选中Create package.info.java复选框。
4. 点击完成

Answer 3

JAutodoc 插件可以很好地解决这个问题，以及所有其他文档需求。安装并配置插件并右键单击该包，然后单击 JAutodoc＆gt;添加包Javadoc

.java或.html包文档中提供了配置和模板。

此插件还可以很好地标准化您的所有Javadoc需求，并进行大量自定义。

http://jautodoc.sourceforge.net/

Answer 4

有一个插件似乎创建了package.html文件。我没有使用它，但登陆这里的人可能会发现它很有用。

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