时间戳

首页 > 解决方案 > 是否可以从 Intellij IDE 访问 Spring 文档？

spring - 是否可以从 Intellij IDE 访问 Spring 文档？

问题描述

我想通过 Intellj 的View->Quick Documentation功能查看 Spring 文档。为此，我通过使用外部文档链接尝试了以下操作：

好的，我已经添加了 Spring Framework 文档的 url。按照指示，但是，当我在 Spring Framework 项目上执行 ctrl+Q 时，它没有显示任何文档。在上面的弹出窗口中...

这是我使用的网址：https ://docs.spring.io/spring-framework/docs/current/javadoc-api/

Intellij 支持

但它不起作用。

有人可以帮忙吗？

标签： springintellij-ideaspringdoc

解决方案

快速文档

“快速文档”不同于“外部文档”。对于“快速文档”，您只需配置您的依赖项以包含源代码。

你有 Maven 或 Gradle 项目吗？

对于 Gradle 和 IntelliJ，您可以在文件中使用gradle-intellij-pluginbuild.gradle(.kts)。它有一个downloadSources选项，默认情况下为 true。

对于 Maven，在 IntelliJ 设置中的“Maven”>“Importing”下，有一个选项可以自动下载源代码、文档和注释。

要查看它是否正常工作或手动执行，请转到 IntelliJ 中的“项目结构”>“项目设置”>“库”。您可以查看并手动添加或修改所有库的源 JAR 和文档 URL。

外部文档

对于外部文档（在浏览器中打开 JavaDoc），您可以告诉 IntelliJ 使用idea Gradle 插件下载 JavaDoc，如下所示：

idea {
    module {
        downloadJavadoc = true 
        //or in Gradle Kotlin DSL:
        //isDownloadJavaDoc = true
    }
}

对于 Maven，该选项再次位于 IntelliJ 设置中。

推荐阅读