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

Question

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

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

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

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

有没有办法将 JavaDoc 添加到这些方法/类/等等？

Answer 1

JavaDoc 是否可用取决于您如何设置 target platform . 源包 或源功能 是IDE 提供JavaDoc 所必需的。

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

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

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