如何为Eclipse插件开发获取JavaDoc文档？

Question

如何为Eclipse插件开发获取JavaDoc文档？

4

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

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

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

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

是否有办法为这些方法/类等添加JavaDoc？

- Raven

2个回答

0

我认为默认情况下位置已经配置到在线工作的Java网站。如果您想要离线文档，请按照以下步骤操作：

首先下载并提取您安装的JRE版本的javadocs。

从Eclipse中转到Windows -> Preferences -> 展开Java -> 安装的JREs -> 选择您需要文档的JRE -> 点击编辑 -> 选择所有系统库 -> 点击JavaDoc位置并选择提取文档的位置。

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

- Greg

我的问题不是完全没有JavaDoc...对于普通的Java使用，它可以正常工作...只有当我开始使用插件和相应的类时，我会收到提示，该类没有附带JavaDoc... - Raven

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Rüdiger Herrmann · Accepted Answer

无论JavaDoc是否可用，都取决于您如何设置目标平台。必须使用源代码包或源特性才能使IDE提供JavaDoc。

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

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

在选择组件时，优先考虑SDK特性或还包括资源特性。例如，包括Eclipse Platform SDK而不是Eclipse Platform，因为它还包含源代码和文档。如果您的目标需要Eclipse Java Development Tools，请确保还包括Eclipse JDT Plug-in Developer Resources，后者也包含文档和源代码。