Java API文档的使用方法详解
作者:橙?子_ 时间:2022-06-15 20:12:03
前言
学会使用 API 文档是一个开发者基本的素养,而许多初学者并不会在意 API 文档的使用,甚至从来没有接触过,所以写下这篇文章探讨 API 文档的使用,希望能够帮助到你,先赞后看,养成习惯!
1. 概念
API,Application Programming Interface, 应用程序编程接口。通俗的说,就是已经定义好的类,我们可以直接使用的。例如我们经常使用的 String 类。
Java 中提供了丰富的基础类,并为这些基础类提供了 API 文档,用于告诉开发者如何使用这些类以及这些类里包含的方法。
在开发者学习过程中,我们不可能去详细的学习每一个类,此时,我们就可以去使用 API 文档查询需要使用的类,包括查看其构造方法,成员变量,成员方法等,JDK API 文档就像是 Java 类的字典,帮助开发者快速使用 Java 定义的一些基础类。
下载:
直接在 Oracle
官网下载即可,但是由于下载速度慢,而且是英文版的原因,我们可以在 CSDN 资源中寻找中文版,1.8 版本是一个翻译的比较好的版本,建议下载使用,这个版本完全可以满足我们的需求。
2. 使用
下面介绍 API 文档的详细使用方法,在我们的开发过程中,如果遇到了一个陌生的类,那么我们就可以通过查询 API 文档,了解这个类的使用。
第一步,打开文档,点击左上角的显示,接着点击索引。
第二步:输入想要查询的类,回车。这里以 Random 类为例。
第三步:查看类名,包名。在使用这个类时,要在程序中进行导包操作,如果这个类在 lang 包下,则不需要进行导包操作。
第四步:查看类的说明,明确这个类的作用。
第五步:查看类的构造方法,学会示例化一个该类的对象。
第五步:查看成员方法,学会使用该类的对象调用相应的方法,解决实际问题。这里的每一个方法都提供了详细的信息,包括作用,返回值,方法名,参数等。
现在我们基本完成了这个类的学习,就可以拿着刚才查询到的信息去完善我们的代码了。
来源:https://blog.csdn.net/zhangxia_/article/details/128594699
![](/images/zang.png)
![](/images/jiucuo.png)
猜你喜欢
JDK8中的HashMap初始化和扩容机制详解
![](https://img.aspxhome.com/file/2023/2/60132_0s.jpg)
java实现图片转base64字符串 java实现base64字符串转图片
![](https://img.aspxhome.com/file/2023/3/77353_0s.png)
SpringCloud Eureka的使用教程
![](https://img.aspxhome.com/file/2023/8/70348_0s.png)
java的io操作(将字符串写入到txt文件中)
10张图总结出并发编程最佳学习路线
![](https://img.aspxhome.com/file/2023/2/77342_0s.jpg)
Spring Boot + Thymeleaf + Activiti 快速开发平台项目 附源码
![](https://img.aspxhome.com/file/2023/5/59865_0s.png)
Hibernate环境搭建与配置方法(Hello world配置文件版)
Springboot jpa @Column命名大小写问题及解决
基于Springboot+Junit+Mockito做单元测试的示例
java并发编程工具类JUC之ArrayBlockingQueue
判断一个整数是否是2的N次幂实现方法
mybatis in foreach 双层嵌套问题
![](https://img.aspxhome.com/file/2023/3/59883_0s.png)
秒懂Java枚举类型(enum)
window下安装和配置maven环境
![](https://img.aspxhome.com/file/2023/4/63664_0s.png)
Java8新特性之空指针异常的克星Optional类的实现
详解在Spring中如何使用AspectJ来实现AOP
@ConfigurationProperties加载外部配置方式
![](https://img.aspxhome.com/file/2023/5/59385_0s.png)
Java 栈与队列实战真题训练
![](https://img.aspxhome.com/file/2023/9/73089_0s.png)
10道springboot常见面试题
Java如何把int类型转换成byte
![](https://img.aspxhome.com/file/2023/6/79816_0s.png)