# 此 API 文档的组织方式

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

## 概览

概览 页面是此 API 文档的首页, 提供了所有程序包的列表及其概要。此页面也可能包含这些程序包的总体说明。

## 程序包

每个程序包都有一页，其中包含它的类和接口的列表及其概要。这些页可以包含六个类别：

- 接口
- 类
- Enum Classes
- 异常错误
- 错误
- Annotation Interfaces

## 类或接口

每个类, 接口, 嵌套类和嵌套接口都有各自的页面。其中每个页面都由三部分 (类/接口说明, 概要表, 以及详细的成员说明) 组成:

- 类继承图
- 直接子类
- 所有已知子接口
- 所有已知实现类
- 类或接口声明
- 类或接口说明

- 嵌套类概要
- 字段概要
- 属性概要
- 构造器概要
- 方法概要

- 字段详细资料
- 属性详细资料
- 构造器详细资料
- 方法详细资料

概要条目按字母顺序排列，而详细说明则按其在源代码中出现的顺序排列。这有助于保持程序员所建立的逻辑分组。

## Annotation Interface

Each annotation interface has its own separate page with the following sections:

- Annotation Interface Declaration
- Annotation Interface Description
- 必需元素概要
- 可选元素概要
- 元素详细资料

## Enum Class

Each enum class has its own separate page with the following sections:

- 枚举声明
- 枚举说明
- 枚举常量概要
- 枚举常量详细资料

## 树 (类分层结构)

对于所有程序包，都有一个 类分层结构 页，以及每个程序包的分层结构。每个分层结构页都包含类的列表和接口的列表。从 `java.lang.Object` 开始，按继承结构对类进行排列。接口不从 `java.lang.Object` 继承。

- 查看“概览”页面时, 单击 "树" 将显示所有程序包的分层结构。
- 查看特定程序包、类或接口页时，单击“树”将仅显示该程序包的分层结构。

## 已过时的 API

已过时的 API 页面列出了所有已过时的 API。通常，由于已过时的 API 存在缺点并且已提供替代 API，不建议使用已过时的 API。在将来的实施中，可能会删除已过时的 API。

## 索引

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

## 序列化表格

每个可序列化或可外部化的类都有其序列化字段和方法的说明。此信息对实施（而非使用）API 的人员有用。尽管导航栏中没有链接，但您可以通过下列方式获取此信息：转至任何序列化类，然后单击类说明的“另请参阅”部分中的“序列化形式”。

## 常量字段值

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

## 搜索

可以使用部分或完整名称搜索模块、程序包、类型、字段、方法、系统属性以及 API 中定义的其他术语的定义，（可选）也可以使用“驼峰大小写式”缩写进行搜索。例如：

- `j.l.obj` 将与 "java.lang.Object" 相匹配
- `InpStr` 将与 "java.io.InputStream" 相匹配
- `HM.cK` 将与 "java.util.HashMap.containsKey(Object)" 相匹配

有关搜索功能的完整说明，请参阅 Javadoc 搜索规范。

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