API文档组织结构说明
-
概述
概述页面是本API文档的首页，提供了所有包的列表及每个包的摘要说明。此页面也可能包含对整个包集的总体描述。
-
软件包
每个包都有一个页面，其中包含其类和接口的列表，并附有每个的摘要。这些页面可能包含六个类别：
- 接口
- 类
- 枚举类型
- 异常
- 错误
- 注解类型
-
类或接口
每个类、接口、嵌套类和嵌套接口都有独立的页面。这些页面包含三个部分：类/接口描述、摘要表格和详细的成员说明：
- 类继承关系图
- 直接子类
- 所有已知的子接口
- 所有已知的实现类
- 类或接口声明
- 类或接口描述
- 嵌套类摘要
- 字段摘要
- 属性摘要
- 构造函数摘要
- 方法摘要
- 字段详情
- 属性详情
- 构造函数详情
- 方法详情
每个摘要条目包含该项目详细描述的第一句话。摘要条目按字母顺序排列，而详细描述则按照它们在源代码中出现的顺序排列。这保留了程序员建立的逻辑分组。
-
注解类型
每种注释类型都有其独立的页面，包含以下部分：
- 注解类型声明
- 注解类型描述
- 必需元素摘要
- 可选元素摘要
- 元素详情
-
枚举
每个枚举类型都有其独立的页面，包含以下部分：
- 枚举声明
- 枚举描述
- 枚举常量摘要
- 枚举常量详情
-
使用
每个已文档化的包、类和接口都有其专属的"使用"页面。该页面描述了哪些包、类、方法、构造函数和字段使用了给定类或包的任何部分。对于类或接口A，其"使用"页面包含A的子类、声明为A类型的字段、返回A类型的方法，以及参数类型为A的方法和构造函数。您可以通过先进入包、类或接口页面，然后点击导航栏中的"使用"链接来访问此页面。
-
树状结构（类层次体系）
所有包都有一个类层次结构页面，每个包也有各自的层次结构。每个层次结构页面包含一个类列表和一个接口列表。类按照继承结构组织，从
java.lang.Object开始。接口不从java.lang.Object继承。- 在查看概览页面时，点击"Tree"会显示所有包的层级结构。
- 在查看特定包、类或接口页面时，点击"Tree"仅显示该包的层次结构。
-
已弃用的API
Deprecated API页面列出了所有已被弃用的API。弃用的API不建议使用，通常是由于改进的原因，并且通常会提供替代API。弃用的API可能会在未来的实现中被移除。
-
索引
索引包含所有类、接口、构造函数、方法和字段的字母顺序索引，以及所有包和所有类的列表。
-
所有类
All Classes链接显示除非静态嵌套类型外的所有类和接口。
-
序列化表单
每个可序列化或可外部化的类都有其序列化字段和方法的描述。这些信息对重新实现者有用，而不是对使用API的开发者。虽然导航栏中没有链接，但您可以通过转到任何序列化类并在类描述的"参见"部分点击"序列化表单"来获取此信息。
-
常量字段值
Constant Field Values页面列出了静态final字段及其对应的值。
-
搜索
您可以通过输入部分或全部名称，搜索API中定义的模块、包、类型、字段、方法等术语的定义。支持"驼峰式"缩写：例如输入"InpStr"可以找到"InputStream"和"InputStreamReader"。
本帮助文件适用于由标准文档工具生成的API文档。