概述 | 软件包 | 类 | 使用 | 树 | 已过时 | 索引 | 帮助
上一个 下一个 | 框架 无框架

# 此 API 文档的组织方式

此 API（应用程序编程接口）文档包含对应于导航栏中的项目的页面，如下所述。

### 概述

> 概述 页面是此 API 文档的首页，提供了所有软件包的列表及其摘要。此页面也可能包含这些软件包的总体描述。

### 软件包

> 每个软件包都有一个页面，其中包含它的类和接口的列表及其摘要。此页面可以包含四个类别：

> - 接口（斜体）
> - 类
> - 枚举
> - 异常
> - 错误
> - 注释类型

### 类/接口

> 每个类、接口、嵌套类和嵌套接口都有各自的页面。其中每个页面都由三部分（类/接口描述、摘要表，以及详细的成员描述）组成：

> - 类继承图
> - 直接子类
> - 所有已知子接口
> - 所有已知实现类
> - 类/接口声明
> - 类/接口描述

> - 嵌套类摘要
> - 字段摘要
> - 构造方法摘要
> - 方法摘要

> - 字段详细信息
> - 构造方法详细信息
> - 方法详细信息
> 每个摘要条目都包含该项目的详细描述的第一句。摘要条目按字母顺序排列，而详细描述则按其在源代码中出现的顺序排列。这样保持了程序员所建立的逻辑分组。

### 注释类型

> 每个注释类型都有各自的页面，其中包含以下部分：

> - 注释类型声明
> - 注释类型描述
> - 必需元素摘要
> - 可选元素摘要
> - 元素详细信息

### 枚举

> 每个枚举都有各自的页面，其中包含以下部分：

> - 枚举声明
> - 枚举描述
> - 枚举常量摘要
> - 枚举常量详细信息

### 使用

> 每个已文档化的软件包、类和接口都有各自的“使用”页面。此页面介绍了使用给定类或软件包的任何部分的软件包、类、方法、构造方法和字段。对于给定的类或接口 A，其“使用”页面包含 A 的子类、声明为 A 的字段、返回 A 的方法，以及带有类型为 A 的参数的方法和构造方法。访问此页面的方法是：首先转至软件包、类或接口，然后单击导航栏中的“使用”链接。

### 树（类分层结构）

> 对于所有软件包，有一个 类分层结构 页面，以及每个软件包的分层结构。每个分层结构页面都包含类的列表和接口的列表。从 `java.lang.Object` 开始，按继承结构对类进行排列。接口不从 `java.lang.Object` 继承。
> - 查看“概述”页面时，单击“树”将显示所有软件包的分层结构。
> - 查看特定软件包、类或接口页面时，单击“树”将仅显示该软件包的分层结构。

### 已过时的 API

> 已过时的 API 页面列出了所有已过时的 API。一般由于进行了改进并且通常提供了替代的 API，所以建议不要使用已过时的 API。在将来的实施过程中，可能会删除已过时的 API。

### 索引

> 索引 包含按字母顺序排列的所有类、接口、构造方法、方法和字段的列表。

### 上一个/下一个

这些链接使您可以转至下一个或上一个类、接口、软件包或相关页面。

### 框架/无框架

这些链接用于显示和隐藏 HTML 框架。所有页面均具有有框架和无框架两种显示方式。

### 序列化表格

每个可序列化或可外部化的类都有其序列化字段和方法的描述。此信息对重新实现者有用，而对使用 API 的开发者则没有什么用处。尽管导航栏中没有链接，但您可以通过下列方式获取此信息：转至任何序列化类，然后单击类描述的“另请参见”部分中的“序列化表格”。

### 常量字段值

常量字段值页面列出了静态最终字段及其值。

此帮助文件适用于使用标准 doclet 生成的 API 文档。

概述 | 软件包 | 类 | 使用 | 树 | 已过时 | 索引 | 帮助
上一个 下一个 | 框架 无框架