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