学会使用 API 文档是一个开发者基本的素养而许多初学者并不会在意 API 文档的使用甚至从来没有接触过所以写下这篇文章探讨 API 文档的使用希望能够帮助到你先赞后看养成习惯

1. 概念

APIApplication Programming Interface 应用程序编程接口。通俗的说就是已经定义好的类我们可以直接使用的。例如我们经常使用的 String 类。

Java 中提供了丰富的基础类并为这些基础类提供了 API 文档用于告诉开发者如何使用这些类以及这些类里包含的方法。

在开发者学习过程中我们不可能去详细的学习每一个类此时我们就可以去使用 API 文档查询需要使用的类包括查看其构造方法成员变量成员方法等JDK API 文档就像是 Java 类的字典帮助开发者快速使用 Java 定义的一些基础类。

下载

直接在 Oracle 官网下载即可但是由于下载速度慢而且是英文版的原因我们可以在 CSDN 资源中寻找中文版1.8 版本是一个翻译的比较好的版本建议下载使用这个版本完全可以满足我们的需求。

2. 使用

下面介绍 API 文档的详细使用方法在我们的开发过程中如果遇到了一个陌生的类那么我们就可以通过查询 API 文档了解这个类的使用。

第一步打开文档点击左上角的显示接着点击索引。

第二步输入想要查询的类回车。这里以 Random 类为例。

第三步查看类名包名。在使用这个类时要在程序中进行导包操作如果这个类在 lang 包下则不需要进行导包操作。

第四步查看类的说明明确这个类的作用。

第五步查看类的构造方法学会示例化一个该类的对象。

第五步查看成员方法学会使用该类的对象调用相应的方法解决实际问题。这里的每一个方法都提供了详细的信息包括作用返回值方法名参数等。

现在我们基本完成了这个类的学习就可以拿着刚才查询到的信息去完善我们的代码了。

---

Java编程基础教程系列

【Java编程进阶】封装继承多态详解

【Java编程进阶】Java抽象类与接口详解

【Java编程进阶】Object类及常用方法详解