如何获取Eclipse插件开发的JavaDoc？

Question

我刚开始为 Eclipse 开发插件，但每当我创建一个示例项目时，都没有针对生成代码中使用的方法的 JavaDoc。

我正在使用 HelloWorld 示例，其中有例如以下生成的代码：

public void run(IAction action) {
  MessageDialog.openInformation(
    window.getShell(),
    "Miau",
    "Hello, Eclipse world");
}

然而，openInformation() 方法没有附加任何 JavaDoc，MeesageDialog 或生成的示例中使用的任何其他 class/method/interface 也没有。

有没有办法将 JavaDoc 添加到那些 methods/classes/etc？

Answer 1

JavaDoc 是否可用取决于您如何设置 target platform。源包或源特性是IDE提供Java文档所必需的。

此外，源代码允许调试平台代码，如果文档不够清晰则查看源代码等。因此，您可能总是希望拥有源代码。

如果您从软件站点向目标平台添加组件，请确保选中如果可用则包含源代码选项。

选择组件时，优先选择 SDK 功能或同时包括 Resource 功能。例如，包含 Eclipse Platform SDK 而不是 Eclipse Platform，因为它还包含源代码和文档。如果您的目标需要 Eclipse Java 开发工具 ，请确保还包含 Eclipse JDT 插件开发人员资源 ，再次后者包含文档和源代码。

Answer 2

我认为该位置默认配置到 java 站点以便在线工作。如果您想离线使用文档，请执行以下操作：

首先下载并解压您安装的 JRE 版本的 java 文档。

从 Eclipse 转到 Windows -> 首选项 -> 展开 Java -> 安装的 JRE -> Select 你想要文档的 JRE -> 单击编辑 -> Select 所有系统库 -> 单击 Java 文档位置和 select 您提取文档的位置。

*编辑 - 刚刚注意到您正在查看的方法不在核心 java 中。如果要将 Java 文档或源添加到引用的库，请展开引用，然后右键单击所需的 jar 和 select 首选项，从那里您可以添加文档或源，您应该可以下载。

如何获取Eclipse插件开发的JavaDoc？

How to get JavaDoc for Eclipse plug-in development?

java

eclipse

eclipse-plugin