首先,这与 Java SE Javadocs 无关。效果很好。
我们有一个基于 Java 的大型平台,包含大约 20 个 API 包。对于使用我们平台的用户,我们希望工具提示和其他此类内置文档支持能够像 Java API 那样工作。
我们的 Javadoc 位于使用我们平台的用户可用的 URL 上,并且在使用通常的方法手动附加到引用的包时可以正常工作。
Eclipse 似乎没有保留 Javadoc 附件 - 也就是说,当您将 Javadoc 附加到捆绑包时,它可以工作,但是当您重新启动 Eclipse 时,该附件就会丢失。
至少有 20 个 API 包,并且使用我们平台的典型工作区至少有 10 个或更多项目,每次 Eclipse 运行时都必须手动将 Javadoc 附加到每个项目的每个引用包中是不可行的(例如,可能是 200 个手动附件)重新启动。
有没有办法让它自动化?我并不排斥某种脚本解决方案,即使每次启动 Eclipse 时都必须运行它,但显然,如果它只是“工作”会更好,就像它对 Java API 所做的那样。 (就此而言,我希望它也适用于各种事物,例如 Apache Commons、Bouncy Castle、Android 等)。
谢谢...
这个问题可以通过在目标平台上提供包含 Javadoc 的捆绑包(不包含源代码)来解决。以下是实现此目标的步骤:
- 创建包含 API 完整 Javadoc 的插件
- 通过定义扩展org.eclipse.pde.core.javadoc扩展点 https://help.eclipse.org/latest/topic/org.eclipse.pde.doc.user/reference/extension-points/org_eclipse_pde_core_javadoc.html在这个插件中是这样的:
<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 位置。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)