对于 Java 而言，API 文档详细说明了 Java 中常用类和方法的功能，开发者可以通过查阅 API 文档，调用应用程序接口（API）来编程。
Java 中很多类，每一个类又有很多方法和变量，通过查看 Java API 文档能够知道这些类、方法和变量如何使用。Java 官方为 Java SE 提供了基于 HTML 的 API 文档。作为 Java 程序员应该熟悉如何使用 API 文档。
本节介绍一下如何使用 Java SE 的 API 文档。Java 官方提供了 Java 8 在线 API 文档，网址是 http://docs.oracle.com/javase/8/docs/api/，页面如图 1 所示。
图 1 Java 8在线API文档
提示：很多读者希望能够有离线的中文 Java API 文档，但 Java 官方只提供了 Java 6 的中文 API 文档，该文件下载地址是 http://download.oracle.com/technetwork/java/javase/6/docs/zh/api.zip，下载完成后解压 api.zip 文件，找到其中的 index.html 文件，双击就会在浏览器中打开 API 文档了。
下面介绍一下如何使用 API 文档，熟悉一下 API 文档页面中的各个部分含义，如图 2 所示，类和接口中，斜文字体显示是接口，正常字体才是类。
图 2 API 文档页面各个部分
在类窗口还有很多内容，向下拖曳滚动条会看到如图 3 所示页面，其中“字段摘要”描述了类中的实例变量和静态变量，“构造方法摘要”描述了类中所有构造方法，“方法摘要”描述了类中所有方法。这些“摘要”只是一个概要说明，单击链接可以进入到该主题更加详细的描述，如图 4 所示单击了 compareTo 方法看到的详细信息。
图 3 类窗口页面其他内容
图 4 compareTo 方法详细描述
查询 API 的一般流程是：找包→找类或接口→查看类或接口→找方法或变量。读者可以尝试查找一下 String、StringBuffer 和 StringBuilder 这些字符串类的 API 文档，熟悉一下这些类的用法。
原创文章，作者：奋斗，如若转载，请注明出处：https://blog.ytso.com/tech/pnotes/21370.html