如何组织此 API 文档
-
概述
概览 (Overview) 页面是本 API 文档的首页，提供了所有包的列表及其摘要。该页面还可以包含关于这组包的总体描述。
-
程序包
每个包都有一个页面，其中包含该包的类和接口列表，以及每个类和接口的摘要。这些页面可能包含六个类别：
- 接口
- 类
- 枚举
- 异常
- 错误 (Errors)
- 注解类型 (Annotation Types)
-
类或接口 (Class or Interface)
每个类、接口、嵌套类和嵌套接口都有其各自的单独页面。这些页面中的每一页都包含三个部分：类/接口描述、摘要表以及详细的成员描述。
- 类继承图
- 直接子类
- 所有已知的子接口
- 所有已知实现类
- 类或接口声明
- 类或接口描述
- 嵌套类概要
- 字段概要
- 属性摘要
- 构造函数概要
- 方法概要
- 字段详细信息
- 属性详细信息
- 构造函数详细信息
- 方法详细信息
每个摘要条目都包含该项详细描述的第一句话。摘要条目按字母顺序排列，而详细描述则按它们在源代码中出现的顺序排列。这保留了程序员所建立的逻辑分组。
-
注解类型
每个注解类型都有其各自的单独页面，包含以下部分：
- 注解类型声明
- 注解类型描述
- 必需元素摘要
- 可选元素摘要
- 元素详细信息
-
枚举
每个枚举都有其各自的单独页面，包含以下部分：
- 枚举声明
- 枚举描述
- 枚举常量摘要
- 枚举常量详细信息
-
树 (类层次结构)
有一个针对所有包的 类层次结构 (Class Hierarchy) 页面，以及每个包各自的层次结构。每个层次结构页面都包含类列表和接口列表。类按继承结构组织，始于
java.lang.Object。接口不继承自java.lang.Object。- 在查看“概览”页面时，点击“树”将显示所有包的层次结构。
- 在查看特定包、类或接口页面时，点击“树”将仅显示该包的层次结构。
-
已过时的 API
已过时的 API (Deprecated API) 页面列出了所有已过时的 API。不建议使用已过时的 API（通常是因为有了改进），并且通常会提供替代 API。已过时的 API 可能会在未来的实现中被移除。
-
索引
索引 (Index) 包含所有类、接口、构造函数、方法和字段的字母索引，以及所有包和所有类的列表。
-
所有类
所有类 (All Classes) 链接显示除了非静态嵌套类型之外的所有类和接口。
-
序列化形式
每个可序列化 (Serializable) 或可外部化 (Externalizable) 的类都有其序列化字段和方法的描述。此信息对重新实现者有用，而不是对使用该 API 的开发人员有用。虽然导航栏中没有直接链接，但您可以通过转到任何已序列化的类，并单击类描述“另请参阅 (See also)”部分中的“序列化形式 (Serialized Form)”来获取此信息。
-
常量字段值
常量字段值 (Constant Field Values) 页面列出了 static final 字段及其值。
-
搜索
您可以使用名称的部分或全部，搜索 API 中定义的模块、包、类型、字段、方法和其他术语的定义。支持“驼峰命名法”缩写：例如，“InpStr”将找到“InputStream”和“InputStreamReader”。
此帮助文件适用于由标准 doclet 生成的 API 文档。