此API文档的组织方式
-
概述
概述页面是此API文档的首页,并提供了所有模块的列表,其中包含每个模块的摘要。此页面还可以包含模块集的整体描述。
-
模块
每个模块都有一个页面,其中包含其包的列表,对其他模块和服务的依赖性,以及每个模块的摘要。这些页面可能包含三个类别:
- 包
- 模块
- 服务
-
软件包
每个包都有一个页面,其中包含其类和接口的列表,每个包都有一个摘要。这些页面可能包含六个类别:
- 接口
- 类
- 枚举
- 例外
- 错误
- 注解类型
-
类或接口
每个类,接口,嵌套类和嵌套接口都有自己独立的页面。这些页面中的每一个都有三个部分,包括类/接口描述,摘要表和详细的成员描述:
- 类继承图
- 直接子类
- 所有已知子接口
- 所有已知的实施类
- 类或接口声明
- 类或接口说明
- 嵌套课程摘要
- 字段汇总
- 财产摘要
- 构造方法摘要
- 方法摘要
- 字段详细信息
- 物业详情
- 构造方法详细信息
- 方法详细信息
每个摘要条目包含该项目详细说明中的第一个句子。摘要条目按字母顺序排列,而详细说明按它们在源代码中出现的顺序排列。这保留了程序员建立的逻辑分组。
-
注释类型
每个注释类型都有自己独立的页面,其中包含以下部分:
- 注释类型声明
- 注释类型说明
- 必填元素摘要
- 可选元素摘要
- 元素明细
-
枚举
每个枚举都有自己独立的页面,其中包含以下部分:
- Enum宣言
- 枚举说明
- 枚举常量摘要
- Enum Constant Detail
-
使用
每个记录的包,类和接口都有自己的使用页面。此页面描述了使用给定类或包的任何部分的包,类,方法,构造函数和字段。给定一个类或接口A,其"使用"页面包括A的子类,声明为A的字段,返回A的方法,以及参数类型为A的方法和构造函数。您可以通过首先转到包,类来访问此页面或界面,然后单击导航栏中的"使用"链接。
-
树(类层次结构)
所有软件包都有一个类层次结构页面,以及每个软件包的层次结构。每个层次结构页面都包含类列表和接口列表。类由继承结构组织,以
java.lang.Object
开头。接口不从java.lang.Object
继承。- 查看"概述"页面时,单击"树"将显示所有包的层次结构。
- 查看特定的包,类或界面页面时,单击"树"会仅显示该包的层次结构。
-
不推荐使用的API
不推荐使用的API 页面列出了所有已弃用的API。建议不要使用已弃用的API,通常是由于改进,并且通常会提供替换API。在将来的实现中可能会删除不推荐使用的API。
-
索引
索引包含所有类,接口,构造函数,方法和字段的字母索引,以及所有包的列表和所有课程。
-
所有类
所有类链接显示除非静态嵌套类型之外的所有类和接口。
-
序列化表格
每个可序列化或可外部化的类都有其序列化字段和方法的描述。重新实现者而不是使用API的开发人员会对此信息感兴趣。虽然导航栏中没有链接,但您可以通过转到任何序列化类并单击类说明的"另请参阅"部分中的"序列化表单"来获取此信息。
-
常数字段值
常量字段值页面列出了静态最终字段及其值。
-
搜索
您可以使用部分或全部名称搜索API中定义的模块,包,类型,字段,方法和其他术语的定义。支持"Camel-case"缩写:例如,"InpStr"将找到"InputStream"和"InputStreamReader"。
此帮助文件适用于标准doclet生成的API文档。