理解Java的API文档

曾几何时，人们仅通过语法特征来判断编程语言(包括 Java)。if语句是否按照您的预期执行?循环语句是否易于使用?方法是否有效实施?

如今，情况有些不同。Java 拥有一整套语法特性，但 Java 不仅仅是一大堆语法规则。Java 有一个标准的应用程序编程接口——一个巨大的库，由 4,000 多个类组成，每个类都有自己的功能、局限性和有效使用的规则。

搜索词条

您可以通过多种不同方式在API文档中找到内容。在一种或另一种情况下，每种方式都很方便。例如，Java 有一个名为System.out.println的方法。下面描述了查找System.out.println方法的两种方法。

使用索引

以下是如何使用索引查找某些内容，例如System.out.println：

1.访问docs.oracle.com/javase/8/docs/api/。

2.点击页面顶部的INDEX链接，打开索引，如图1所示。

字母列表位于索引顶部附近(参见图 2)。单击 P 链接转到包含println的部分。

3.在P部分，搜索println以找到println条目。

大多数 Web 浏览器都允许您在页面文本中搜索println之类的内容。就是这样：

(1)确保浏览器知道您要在占据大部分页面的大框架中进行搜索(而不是在页面左侧的较小框架中)。为此，请在大框架内单击鼠标。(不要单击链接。单击框架的一些中性白色区域。)

(2)打开浏览器的查找对话框。在大多数 Windows 浏览器上，按 Ctrl+F 可使“查找”对话框隐藏。在 Mac 上，单击 Command+F 即可解决问题。

(3)当您看到“查找”对话框时，在文本框中键入println并单击该框的“查找”或“查找下一个”按钮。

4.选择println条目之一。

P部分有大量的println条目，如下面的图 3 所示。这些条目在两个方面彼此不同：

每个条目都表示println(int)、println(String)或println(someOtherTypeName)。类型名称可以从一个条目到另一个条目不同。

每个条目都表示println是类java 中的一个方法。someStuff.someMoreStuff。该类可以从一个条目到另一个条目不同。

在这一点上，四处看看是值得的。如果您尝试打印诸如“Hello world!”之类的内容 ，您需要println(String)条目之一。在另一方面，如果你想打印的价值勒ngthOfStraightLine，你可能会选择的println(双)项。

现在，假设您已经决定使用println(String)。您可以从三个println(String)条目中进行选择。一个说，这是在类中的方法java.io.PrintStream中，接下来就是在类中的方法java.io.PrintWriter中， 第三个是在类中的方法java.sql.DriverManager中。你选择这三个条目中的哪一个?

好吧，您真正想要调用的是名为System.out.println 的东西。如果您使用Systemout完成整个查找繁琐，您会发现System.out 的类型为PrintStream。(参见下面的图 4。)所以您决定选择的println(String)条目是

println(String) – 类 java.io.PrintStream 中的方法。

5.单击您选择的条目的链接。

当您单击 println(String) 链接时，浏览器会将您带到一个解释println方法的页面，如图 5 所示。该页面告诉您println做了什么(“打印一个字符串然后...... ”)和指向其他有用的页面，例如带有String文档的页面。

使用类列表

1.以下是通过从类列表开始在 API 中查找条目的方法：

2.访问docs.oracle.com/javase/8/docs/api/。

找到记录System类的页面。

您正在寻找解释System.out.println 的文档。因此，您查找System，按照自己的方式进行out，然后从那里按照自己的方式进行println。

要找到指向System的链接，请查看页面左侧的下方框架。(参见图 6。)有关在页面上查找文本的提示，请参见“使用索引”部分中的步骤 3。

单击 System 链接使您的浏览器显示System类的文档页面，如图 7 所示。

3.在System类的文档页面上，找到out变量。

如果您使用 Web 浏览器的“查找”对话框，则必须多次单击“查找下一个”按钮。(out名称非常常见，它在System文档页面上的几个不同上下文中多次出现。)当您找到要查找的内容时，您会看到一个类似于上面图 4 中所示的表格。

4.在表的输出行中，单击 PrintStream 链接。

根据文档，out变量指的是PrintStream类型的对象。这意味着println是PrintStream类的一部分。这就是您单击PrintStream链接的原因。

5.在PrintStream的文档页面上，找到println(String)。

您会看到类似上面图 5 所示的解释。

以上就是关于“理解Java的API文档”的介绍，你都了解了吗？如果有朋友对Java感兴趣，可以关注一下动力节点Java视频页面，里面的视频从入门到精通全套都有，可以免费下载学习，这对Java学习会有很大帮助。