【问题标题】:Can I add JavaDoc to a package easily with Eclipse?我可以使用 Eclipse 轻松地将 JavaDoc 添加到包中吗?
【发布时间】:2010-10-27 23:12:05
【问题描述】:

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

【问题讨论】:

标签: eclipse javadoc


【解决方案1】:

4 年后更新(2013 年 10 月)

javabeangrinderanswer(已投票)提到了以下技巧:

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

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

原始答案(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的评论):

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

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

【讨论】:

  • 是否有办法让包 javadocs 显示在 Javadoc 快速查看窗口中 - 就像它们对类、接口和方法所做的那样?
  • @Strawberry:不,没有用于 package-info.java 的 Javadoc 视图。请参阅我的扩展答案。
  • 提醒自己,在this question 之后,我又要跨越200K了! (由于一些rep recalc
  • @Mr_and_Mrs_D 确实很好的解决方案。我已将其收录并通知了他的作者。
【解决方案2】:

在日食中

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

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

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

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

【讨论】:

  • 哈哈,太直观了,谢谢 :) 它没有回答问题,但它帮助了我!
  • +1。 At the requestMr_and_Mrs_D,我在上面的回答中引用了它(并赞成你的回答)。
  • 在 Kepler 中,复选框现在显示“创建 package-info.java”。信不信由你,上面第 3 步中缺少连字符让我有些困惑。
  • 在 Luna 上,如果不指定新的包名,它不会让我这样做。
【解决方案3】:

JAutodoc 插件在这方面做得很好,也可以满足您的所有其他文档需求。安装并配置插件并右键单击包并单击 JAutodoc > 添加包 Javadoc

.java.html 包文档有可用的配置和模板。

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

http://jautodoc.sourceforge.net/

【讨论】:

    【解决方案4】:

    似乎有一个插件可以创建 package.html 文件。我没用过,但登陆这里的人可能会觉得它很有用。

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

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2011-06-20
      • 2019-06-21
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      相关资源
      最近更新 更多