logo标签列表

我可以使用Eclipse轻松地向一个包添加JavaDoc吗？

eclipsejavadoc
40

我使用javadoc来记录我的类和方法。我也想为我的package添加一些概述信息。我喜欢Eclipse在我键入/**<Enter>时为每个类或方法创建匹配的文档注释存根的方式。Eclipse是否有一种简便的方法来生成package.html文件？

12
注意：从Java 1.5开始，包注释的首选位置是package-info.java，而非package.html。这样可以定义包级别的注解。请参见http://java.sun.com/javase/6/docs/technotes/guides/javadoc/whatsnew-1.5.0.html。 - Michael Myers
4个回答
51

四年后更新（2013年10月）

javabeangrinder的答案（得到了赞同）提到了以下技巧：

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

  • 右键单击要放置package-info.java的包。
  • 选择新建->包。
  • 勾选Create package.info.java复选框。
  • 点击完成

原始回答（2009年5月）

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

正如mmyers在他的评论中所说，自从Java1.5以来，正确的文件将会是package-info.java。
这个文件不仅可以用于javadoc，还可以用于包级别的注释（如此处所示）。

已有一个开放的Bug（#86168）要求为创建package-info.java提供向导（因为类向导不允许使用package-info名称）。

对此问题的反思始于... 2005年！问题在于任何解决方案都应该以一种能够帮助到1.4代码为前提进行实施。

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

alt text
(来源：developpez.com)

注意（回复Strawberry的评论）：

两者都希望在Javadoc视图中的package-info.java中预览包概述。

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

1
有没有办法让Java文档包在Javadoc快速视图窗口中显示，就像类、接口和方法一样？ - Martin
1
@Strawberry：没有针对package-info.java的Javadoc视图。请查看我的详细回答。 - VonC
提醒自己，在回答这个问题后，我的声望又要再次超过200K了！（由于一些声望重新计算） - VonC
@Mr_and_Mrs_D 确实是个好的解决方案。我已经包含了它并通知了作者。 - VonC
15

在Eclipse中

由于package-info.java不是一个有效的类标识符，因此它不能被创建为Eclipse中的类。

我发现当您创建一个新包时，有一个复选框可以选择是否要一个package-info.java文件。

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

  1. 右键单击您想要放置package-info.java文件的包。
  2. 选择新建->包。
  3. 勾选“创建package.info.java”复选框。
  4. 点击完成。
哈哈，这很直观，谢谢 :) 这并没有回答问题，但是它帮助了我！ - James Bassett
在 Kepler 中，复选框现在显示为“创建 package-info.java”。信不信由你，在上面的第三步中缺少连字符稍微让我有些困惑。 - martin jakubik
1
在Luna上，如果不指定新的包名称，我将无法执行此操作。 - Ellen Spertus
13

JAutodoc 插件可以很好地完成此任务，以及您的其他文档需求。安装和配置插件后，右键单击包并选择 JAutodoc > Add Package Javadoc。

该插件还提供了用于 .java 或 .html 包文档的配置和模板。

此插件还可以很好地标准化所有 Javadoc 需求，并具有大量自定义功能。

http://jautodoc.sourceforge.net/

3
网页内容由stack overflow 提供, 点击上面的
可以查看英文原文，
原文链接