是否可以从Intellij IDE访问Spring文档?

时间:2020-04-07 08:13:43

标签: spring intellij-idea springdoc

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

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

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

Intellij Support

但是它不起作用。

有人可以帮忙吗?

1 个答案:

答案 0 :(得分:4)

快速文档

“快速文档”与“外部文档”不同。对于“快速文档”,您只需要配置依赖项以包括源。

您有Maven或Gradle项目吗?

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

对于Maven,可以通过IntelliJ设置中的“ Maven”>“导入”下的选项自动下载源,文档和注释。

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

外部文档

对于外部文档(在浏览器中打开JavaDoc),您可以告诉IntelliJ使用idea Gradle插件下载JavaDoc,如下所示:

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

对于Maven,该选项再次位于InelliJ设置中。