JavaDoc 帮助
导航
从概览页面开始,您可以使用每个页面中的链接以及每个页面顶部的导航栏浏览文档。索引和搜索框允许您导航到特定的声明和摘要页面,包括:所有包、所有类和接口搜索
您可以使用部分或全部名称,并可选择使用“驼峰式”缩写,搜索 API 中定义的模块、包、类型、字段、方法、系统属性和其他术语的定义。例如
j.l.obj
将匹配 "java.lang.Object"InpStr
将匹配 "java.io.InputStream"HM.cK
将匹配 "java.util.HashMap.containsKey(Object)"
有关搜索功能的完整描述,请参阅 Javadoc 搜索规范。
页面类型
以下部分描述了此集合中不同类型的页面。概述
概览页面是此 API 文档的首页,提供所有包的列表以及每个包的摘要。此页面还可以包含对这组包的总体描述。
包
每个包都有一个页面,其中包含其类和接口的列表,以及每个类的摘要。这些页面可能包含以下类别
- 接口
- 类
- 枚举类
- 异常
- 错误
- 注解接口
类或接口
每个类、接口、嵌套类和嵌套接口都有自己的单独页面。每个页面包含三个部分:声明和描述、成员摘要表和详细成员描述。如果这些部分中的条目为空或不适用,则省略。
- 类继承图
- 直接子类
- 所有已知子接口
- 所有已知实现类
- 类或接口声明
- 类或接口描述
- 嵌套类摘要
- 枚举常量摘要
- 字段摘要
- 属性摘要
- 构造器摘要
- 方法摘要
- 必选元素摘要
- 可选元素摘要
- 枚举常量详细信息
- 字段详情
- 属性详情
- 构造器详细信息
- 方法详情
- 元素详情
注意:注解接口具有必选和可选元素,但没有方法。只有枚举类具有枚举常量。记录类的组件作为记录类声明的一部分显示。属性是 JavaFX 的一个特性。
摘要条目按字母顺序排列,而详细描述按其在源代码中出现的顺序排列。这保留了程序员建立的逻辑分组。
其他文件
包和模块可能包含与附近声明相关的额外信息页面。
树 (类层次结构)
有一个针对所有包的类层次结构页面,以及每个包的层次结构。每个层次结构页面包含一个类列表和一个接口列表。类按继承结构组织,从 java.lang.Object
开始。接口不继承自 java.lang.Object
。
- 当查看“概览”页面时,点击“树”显示所有包的层次结构。
- 当查看特定包、类或接口页面时,点击“树”只显示该包的层次结构。
常量字段值
常量字段值页面列出静态 final 字段及其值。
序列化形式
每个可序列化或可外部化的类都对其序列化字段和方法进行了描述。此信息对于实现者而非 API 使用者感兴趣。虽然导航栏中没有链接,但您可以通过转到任何序列化类并在类描述的“另请参阅”部分中点击“序列化形式”来获取此信息。
所有包
所有包页面包含文档中所有包的字母索引。
所有类和接口
所有类和接口页面包含文档中所有类和接口的字母索引,包括注解接口、枚举类和记录类。
索引
此帮助文件适用于标准 doclet 生成的 API 文档。