需要帮助将特定供应商的Javadoc集成到Eclipse中

时间：2013-01-24 21:52:42

标签： java eclipse javadoc

我正在研究大型Java企业软件（MatrixOne / ENOVIA V6，如果你介意的话）。维护者提供了某种Javadoc，看起来非常香草Javadoc，我可以在浏览器中将其作为HTML读取。

但是，我无法将它集成到Eclipse中，这很痛苦，因为我必须往返浏览器。在Eclipse中，我只是得到了可怕的Note: This element neither has attached source nor attached Javadoc and hence no Javadoc could be found.： enter image description here

在learning之后可以在项目和.jar级别定义Javadoc，我试图做到这两点，知道：

  1. javadoc文件夹包含a package-list file，似乎可以明确定义已记录的包
  2. javadoc文件夹包含典型的文件夹/子文件夹包结构，其中包含ClassName.html个文件。例如。我的com.matrixone.apps.domain文件的package-list行与com/matrixone/apps/domain结构匹配，其中包含大量ClassName.html个文件
  3. javadoc文件夹不包含index.html文件

    4. 当我尝试定义我的Javadoc时，Validate...按钮因缺少index.html而失败。然后，如果我创建一个虚拟index.html文件，验证可以正常工作，但在悬停供应商类/方法时我仍然看不到Javadoc。

    所以我的问题是：让这个倾斜的Javadoc显示在Eclipse中缺少什么？我在这一点上看到的子问题是：

    1. 创建虚拟index.html文件是不是一个坏主意？如果是，我该怎么办？ （即Eclipse期望什么标签/元信息？）
    2. 标准Javadoc文件（String.html）与其中一个供应商Javadoc（DomainObject.html）的快速比较表明，我的javadoc中不存在Eclipse可能使用的元信息。例如，我的供应商Javadoc不包含<meta> Javadoc String.html中存在的多个<head>标记。
      →有人知道Eclipse用来获取方法/类Javadoc的逻辑/启发式吗？ 也许指向我的代码？有了这些信息，我可以弄清楚我的Javadoc中有什么问题，并希望能解决它。
    3. 如果你遇到过类似的问题，你认为合适的任何事情。

      4. 我目前正在Windows 7的Java 7上使用Eclipse Juno SR1。

      当然，请随时评论以询问我忘记包含的信息。谢谢你的帮助！

1 个答案:

答案 0 :(得分：1)

我有类似的问题;但是，我没有尝试通过使用JavaDoc for JDOM的本地副本来解决它。相反，我试图使用适当的URL（当前版本的JDOM的JavaDoc URL为http://jdom.org/docs/apidocs/）。因此，在我的Eclipse项目的Java Build Path配置中的jdom.jar库中，我配置了URL并点击Validate按钮。 Eclipse似乎认为它是有效的，但是我仍然遇到了关于没有附加JavaDoc的相同错误。

然后我发现jdom.org还有旧版JDOM（http://www.jdom.org/docs/apidocs.1.1/）的JavaDoc。所以，我在jdom.jar库JavaDoc配置上尝试了这一点，并且有效！

我学到的经验是，当Eclipse决定是否使用已配置的JavaDoc（被认为是附加的）时，似乎会考虑库的版本。 确保库版本与库的JavaDoc版本相匹配（现在我已经发现了它）。

希望这有帮助。

相关问题
最新问题