Question

首先，这不是Java SE Javadocs。这很好。

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

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

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

使用至少20个API包，以及使用我们的平台至少包含10个或更多项目的典型工作空间，不得不为每个项目手动将Javadoc附加到每个引用的包中（每个项目可能是200个手动附件）时间Eclipse重新启动。

有没有办法实现自动化？我不是在某种脚本解决方案之上，即使它必须在Eclipse每次启动时运行，但显然，如果它只是“工作”，它对Java API的方式会更好。（就此而言，我喜欢这个也适用于各种各样的东西，如Apache Commons，Bouncy Castle，Android等。）

...谢谢

Answer 1

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

创建包含API完整Javadoc的插件
通过org.eclipse.pde.core.javadoc extension point在此插件中定义扩展名，如下所示：

<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>

导出此插件并将其添加到目标平台

如果您的Javadoc已经可以通过URL在线使用，则只需创建定义扩展名的插件并将URL设置为Javadoc元素的路径即可。

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

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

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

1 个答案: