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