【问题标题】:Is it possible to access Spring Documentation from Intellij IDE?是否可以从 Intellij IDE 访问 Spring 文档?
【发布时间】:2020-07-19 09:10:40
【问题描述】:

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

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

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

Intellij Support

但它不起作用。

有人可以帮忙吗?

【问题讨论】:

    标签: spring intellij-idea springdoc


    【解决方案1】:

    快速文档

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

    您有 Maven 或 Gradle 项目吗?

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

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

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

    外部文档

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

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

    对于 Maven,该选项再次出现在 InelliJ 设置中。

    【讨论】:

    • 好的,IntelliJ 里面有 maven 的设置。我为你更新了答案。
    • 谢谢,我必须通过右键单击项目->Maven->下载文档来启动下载。现在它运行良好。
    • 还有没有办法在spring相关类上启用外部文档(即选择一个spring类类型,使用'external documentation'命令在浏览器中查看它的api)?我将项目设置中的文档路径配置为docs.spring.io/spring-framework/docs/current/javadoc-api,但它不起作用
    • @hafan96 您可以按照此处所述尝试:dzone.com/articles/… 我也会更新我的答案。
    • 对于那些来自stackoverflow.com/a/20746942/1243462的人来说,这是在IDEA中获得Eclipse风格行为的正确方法。如果这个 ALONE 不起作用,您需要右键单击项目根目录 -> "Maven" -> "Download sources and Documentation" 。最后,"File" -> "Invalidate Caches" 并重启。
    猜你喜欢
    • 2012-08-06
    • 2013-05-14
    • 2021-01-14
    • 2014-05-11
    • 1970-01-01
    • 1970-01-01
    • 2021-09-21
    • 2011-01-19
    • 2021-11-18
    相关资源
    最近更新 更多