将鼠标悬停在其方法和类上时如何显示导入库的 Javadoc？

Question

如标题中所述。我们目前正在使用JSFML和Swing开发一个项目，我想在VSCode中查看JSFML的Javadoc。但是，当我尝试将鼠标悬停以显示 Javadoc 时，它并没有，而是只向我抛出了一条简单的线。

例如：我使用 JSFML 的包之一，图形（类RenderWindow）构建了一个renderWindow，并尝试悬停。它向我展示了这一点：

org.jsfml.graphics.RenderWindow.RenderWindow(VideoMode arg0, String arg1)

而不是它的Javadoc。当我进入定义时，我在其类文件的开头看到了这样的注释，而不是 Javadoc：

 // Failed to get sources. Instead, stub sources have been generated by the disassembler.
 // Implementation of methods is unavailable.

如何在 VSCode 中查看它的 Javadoc？或者我实际上是不允许的，因为它受到限制（？）

Link for JSFML here if it helps:

Answer 1

Molly 的回答解释了为什么 javadoc 不适用于您的 JAR。

如果您使用的 JSFML 或任何其他 Java 依赖项具有源 jar，VS Code 可以使用它，因此您可以像查看 JDK 一样查看源代码及其 Javadoc。使其在 VS Code 中可见的步骤是：

在带有附加源的 VS Code 中查看 Javadoc 的步骤

1. 获取依赖项的源 JAR（例如手动下载、使用 Maven、...）
2. 在 VS Code 中，点击进入要查看 Javadoc 的类（例如 org.jsfml.graphics.RenderWindow.RenderWindow）
3. 在带有消息Failed to get sources. Instead, stub sources have been generated by the disassembler... 打开的文件中，右键/alt 单击以打开上下文菜单并选择附加源。
4. 选择您之前获得的源 JAR。
5. Javadoc 和依赖源现在将在 VS Code 中可见，并且 Javadoc 将在悬停时显示。

步骤截图

Attach Source in context menu

Select source jar

致谢

这个解决方案最初是在https://github.com/redhat-developer/vscode-java/issues/1855#issuecomment-823142835 中针对类似问题提出的。

Answer 2

那是因为从官网下载的jar包没有说明。

如您所见，当我们将鼠标悬停在函数println 上并ctrl+click 以查看其类时，文档字符串和参数信息来自类中的cmets：

但是，RenderWindow.class 没有这种 cmets，所以 java 扩展只会显示它的包结构：

它与 VS Code 或 Java 扩展无关，而是 jsfml.jar 本身，您可以查看 JSFML javadoc 以获取更多详细信息。