如何在 Eclipse 中查看 Spring Framework Javadoc?

Posted

技术标签:

【中文标题】如何在 Eclipse 中查看 Spring Framework Javadoc?【英文标题】:How to view the Spring Framework Javadoc in Eclipse? 【发布时间】:2013-09-30 08:54:33 【问题描述】:

我有一个包含 Spring Framework API 文档的 html 文件的文件夹,http://docs.spring.io/spring/docs/3.2.4.RELEASE/javadoc-api/。

我希望能够将鼠标悬停在 Eclipse 中的 Spring 方法/接口/等的名称上(如 ClassPathXmlApplicationContext 类),并从这些文档中显示解释。目前,我得到的是“注意:这个元素既没有附加源也没有附加 Javadoc,因此找不到 Javadoc”。

有没有办法告诉 Eclipse 实现该文件夹及其子文件夹以使这些 Javadocs 工作?我必须先以某种方式包装它们吗?我正在使用 Spring Tool Suite,或者我可以使用常规 Eclipse。

我尝试了一些其他答案中推荐的东西,但我不知道发生了什么。

如果有人能帮忙,那就太好了。

【问题讨论】:

使用 Maven 以一种非常优雅的方式解决了这个问题... 你能给我一个链接来下载 Spring 3.1.0 的 Spring Framework API 文档吗?没有地方可以下载。我到处搜索。 你可以在这个link访问所有spring api 【参考方案1】:

这很容易。

您可以简单地右键单击您的项目并转到Maven -> Download JavaDoc,您也可以选择Maven -> Download Sources

如果由于某种原因这不起作用,您也可以运行:

mvn dependency:resolve -Dclassifier=javadoc

然后选择Maven -> Update Project ...

【讨论】:

这不适用于 spring,详见***.com/questions/17086272/… 这可能取决于您的 Eclipse 版本。使用 Eclipse Neon 效果很好。 我正在使用霓虹灯【参考方案2】:

如果您想学习一项很酷的新技术,请查看Maven。据该网站称,

Apache Maven 是一个软件项目管理和理解工具。 基于项目对象模型(POM)的概念,Maven可以管理 一个项目的构建、报告和文档来自一个中心部分 信息。

您可以使用它为您的项目添加依赖项。我不会详细介绍,但是当您这样做时,Maven 会下载如果可用这些依赖项的源代码,通常是源代码和 javadoc jars。然后,您可以简单地 Open Declaration (F3) 您感兴趣的类并检查其源代码或 javadoc。下载源代码后,将鼠标悬停在类、方法、字段等上时也会提供 javadoc。

【讨论】:

这只有在 maven 依赖也提供 javadoc 和源代码时才有效。【参考方案3】:

转到项目的属性并选择Java Build Path,然后选择名为Libraries 的选项卡,在那里您可以展开任何jar 以选择Source attachmentJavadoc location,然后单击Edit 按钮。在出现的对话框中,您可以指定包含源代码的文件夹、JAR 或 zip,或者 Javadoc 的位置路径或 URL。

希望这会有所帮助。

【讨论】:

以上是关于如何在 Eclipse 中查看 Spring Framework Javadoc?的主要内容,如果未能解决你的问题,请参考以下文章

Eclipse中Spring插件的安装及使用

如何使用spring-tool-suite-3.4.0.release-e4.3.1-win32-x86

在Eclipse-jee-neon中配置springsource-tool-suite

如何查看spring源码

在eclipse中配置spring插件

spring源码转eclipse工程(查看spring源码)