☰

如何从 IntelliJ IDEA 在浏览器中启动 API 文档

tag-icon • tag-icon intellij-idea documentation api
如何从 IntelliJ IDEA 在浏览器中启动 API 文档

我刚刚下载了 IntelliJ IDEA，并尝试用它做一些有用的事情。我正在使用 scala 插件。似乎 IntelliJ 下载了 build.sbt 项目依赖项中提到的所有库 + javadoc。

如何从 IntelliJ 启动基于浏览器的 API 文档？我正在寻找一种方法来查看 API 中的所有类。

例子：

我在我的项目中使用 scalajs-dom 库。然后我想从 IntelliJ IDEA 内部的某个地方启动以下文档（IntelliJ 已将其下载到我的系统中）：http://www.scala-js.org/api/scalajs-dom/0.9.0/#org.scalajs.dom.package

在我看来，启动它的最佳位置可能是项目窗口/外部库/scalajs-dom，但它不在那里。

另一个好地方可能是在编辑器中，每当您指向属于 scala.js 库的类时，您可以从弹出菜单中选择“API 文档”之类的内容，但它也不在那里。

编辑：IntelliJ IDEA 关于外部文档的帮助：https://www.jetbrains.com/idea/help/viewing-external-documentation.html

  • 在我的 IDEA（社区版 v15.0.4）中，视图菜单中没有外部文档命令
  • 即使选择了具有 javadoc 的类，按 Shift+F1 也不会执行任何操作
  • 快速文档查找窗口向上箭头（=查看外部文档）始终处于禁用状态

但是在项目窗口/外部库上，选择一个库，然后打开库设置，我看到有库、源和 javadocs。

快速文档窗口运行良好。

EDIT2：如果我按下 Ctrl + Shift + A，IntelliJ 将打开“输入操作或选项名称”对话框。外部文档在那里，但它是灰色的，我无法选择它或对它执行任何操作。

答案1

External Documentation尝试通过Ctrl++Shift搜索动作功能来查找动作A。它必须在 中Code View Actions。

要Quick Documentation通过Shift+启用F1，请转到项目结构并在这里的选项卡SDKs上Documentation Paths指定 URL点击地球的加号。

在此处输入图片描述

所以现在也Quick Documentation必须工作View external documentation。

答案2

被禁用的唯一原因View External Documentation是 IDEA 无法找到您的类的 javadoc 文件。您必须确保要在外部查看器中查看文档的每个依赖项都有 javadoc 文件。

在 IDEA 中，您可以右键单击项目并选择Maven -> Download Documentation将所有依赖项的 javadoc 文件放置到位。

这里是另一个 SO 问题，它展示了如何将 javadocs 附加到选定的依赖项

相关内容