关于工具包的 Javadoc 信息查阅
作者:谎言诞行    发布时间:2024年11月04日

        关于工具包的代码,本人在 Java 类名、属性名、函数名上都书写了大量的代码注释。这些注释在书写代码时,可以通过集成开发环境(IDE)的代码提示功能,显示出来。虽说注释不是很详细,但是也能看懂。如果想要获取标准的 Java API 信息,可以通过解压代码库的 Javadoc 文件获取。方法如下:

0、配置 maven下载 Javadocs 和 source 源码

        在本文介绍的 2 种方式中选一种即可。如果要了解其它方式,可以参考下面的博客链接:Maven 中下载jar包源码和javadoc的命令介绍 - 简书(https://www.jianshu.com/p/8fad1a5c792a

0.1 eclipse 的方式,在配置中设置 maven 工具每次 update 都下载 源码 和 Javadoc

image.png

0.2 mvn 命令行方式。进入测试项目的根目录,打开命令行工具 console 。然后输入以下命令:

mvn dependency:sources
mvn dependency:resolve -Dclassifier=javadoc

1、找到本地 maven 仓库的位置(以我自己的安装位置为例)

image.png

image.png

2、找到对应版本的工具包路径

image.png

3、找到 Java doc 文件

image.png

4、解压 Javadoc 文件(用解压工具即可,比如:7zip 或者 win rar)

image.png

5、用浏览器打开入口文件

image.png

6、简单的查阅示例

image.png


填写一种颜色的字符(不区分大小写),1分钟有效,点击图片刷新