时间戳

首页 > 解决方案 > 有没有办法在 Eclipse 中为非 JRE 包自动化 Javadoc 附件？

java - 有没有办法在 Eclipse 中为非 JRE 包自动化 Javadoc 附件？

问题描述

首先，这与 Java SE Javadocs 无关。这工作正常。

我们有一个基于 Java 的大型平台，包含大约 20 个 API 包。对于使用我们平台的人，我们希望工具提示和其他此类内置文档支持能够像 Java API 一样工作。

我们的 Javadocs 位于一个可供使用我们平台的人使用的 URL，并且在使用通常的方法手动附加到引用的包时可以正常工作。

Eclipse 似乎没有保留 Javadoc 附件——也就是说，当您将 Javadoc 附加到一个包时，它可以工作，但是当您重新启动 Eclipse 时，该附件会丢失。

至少有 20 个 API 包，并且使用我们平台的典型工作区至少有 10 个或更多项目，必须手动将 Javadocs 附加到每个项目的每个引用包是不可行的（可能是 200 个手动附件，例如）每次 Eclipse重新启动。

有什么办法可以自动化吗？我不是在某种脚本解决方案之上，即使它必须在每次启动 Eclipse 时运行，但很明显，如果它只是“工作”会更好，就像它为 Java API 所做的那样。（就此而言，我希望它也适用于各种事物，如 Apache Commons、Bouncy Castle、Android 等）。

谢谢...

标签： javaeclipseeclipse-pluginjavadoc

解决方案

这个问题可以通过为您的目标平台提供一个包含 Javadoc 的包来解决（不包括源代码）。以下是实现此目的的步骤：

  1. 创建包含 API 的完整 Javadoc 的插件
  2. 通过此插件中的org.eclipse.pde.core.javadoc扩展点定义扩展，如下所示：
<extension point="org.eclipse.pde.core.javadoc">
    <javadoc path="javadoc"> <!-- relative path to the API javadoc directory (can also be a URL) -->
        <plugin id="com.acme.core"/>
        <plugin id="com.acme.ui"/>
        <!-- list plug-ins which have been documented in the docs -->
    </javadoc>
</extension>
  1. 导出此插件并将其添加到目标平台

如果您的 Javadoc 已经通过 URL 在线提供，您只需创建定义扩展的插件并将 URL 设置为 Javadoc 元素的路径：

<javadoc path="https://acme.com/apidocs">

Eclipse IDE 将通过 PDE 扩展为您的包自动解析 Javadoc 位置。

推荐阅读