JavaDoc 帮助


导航

概览 页开始,您可以使用每页中的链接以及每页顶部导航栏中的链接来浏览文档。 使用 索引 和搜索框可以导航到特定声明和概要页,包括:所有程序包, 所有类和接口

页面类型

以下各部分介绍了此集合中不同类型的页面。

概览

概览 页面是此 API 文档的首页, 提供了所有程序包的列表及其概要。此页面也可能包含这些程序包的总体说明。

程序包

每个程序包都有一页,其中包含它的类和接口的列表及其概要。这些页可以包含以下类别:

  • 接口
  • 枚举类
  • 异常错误类
  • 注释接口

类或接口

每个类、接口、嵌套类和嵌套接口都有自己独立的页面。如果这些部分中每个部分的条目为空或不适用,则省略这些条目。

  • 类继承图
  • 直接子类
  • 所有已知子接口
  • 所有已知实现类
  • 类或接口声明
  • 类或接口说明

  • 嵌套类概要
  • 枚举常量概要
  • 字段概要
  • 属性概要
  • 构造器概要
  • 方法概要
  • 必需元素概要
  • 可选元素概要

  • 枚举常量详细资料
  • 字段详细资料
  • 属性详细资料
  • 构造器详细资料
  • 方法详细资料
  • 元素详细资料

注: 注释接口有必需的元素和可选的元素,但没有方法。 只有枚举类有枚举常量。 记录类的组件显示为记录类声明的一部分。 属性是 JavaFX 的一个特性。

概要条目按字母顺序排列,而详细说明则按其在源代码中出现的顺序排列。这有助于保持程序员所建立的逻辑分组。

其他文件

程序包和模块所包含的页面中可能带有与附近声明相关的附加信息。

使用

每个已文档化的程序包、类和接口都有各自的“使用”页面。此页面介绍了使用给定类或程序包的任何部分的程序包、类、方法、构造器和字段。对于给定的类或接口 A,其“使用”页面包含 A 的子类、声明为 A 的字段、返回 A 的方法,以及带有类型为 A 的参数的方法和构造器。访问此页面的方法是:首先转至程序包、类或接口,然后单击导航栏中的“使用”链接。

树 (类分层结构)

对于所有程序包,都有一个 类分层结构 页,以及每个程序包的分层结构。每个分层结构页都包含类的列表和接口的列表。从 java.lang.Object 开始,按继承结构对类进行排列。接口不从 java.lang.Object 继承。

  • 查看“概览”页面时,单击“树”将显示所有程序包的分层结构。
  • 查看特定程序包、类或接口页时,单击“树”将仅显示该程序包的分层结构。

已过时的 API

已过时的 API 页面列出了所有已过时的 API。通常,由于已过时的 API 存在缺点并且已提供替代 API,不建议使用已过时的 API。在将来的实施中,可能会删除已过时的 API。

常量字段值

常量字段值页面列出了静态最终字段及其值。

序列化表格

每个可序列化或可外部化的类都有其序列化字段和方法的说明。此信息对实施(而非使用)API 的人员有用。尽管导航栏中没有链接,但您可以通过下列方式获取此信息:转至任何序列化类,然后单击类说明的“另请参阅”部分中的“序列化形式”。

所有程序包

所有程序包 包含文档中所有程序包的按字母顺序排列的索引。

所有类和接口

所有类和接口 包含文档中所有类和接口(包括注释接口、枚举类和记录类)的按字母顺序排列的索引。

索引

索引 包含文档中所有类、接口、构造器、方法和字段的按字母顺序排列的索引,以及概要页(例如 所有程序包, 所有类和接口)。


此帮助文件适用于由标准 doclet 生成的 API 文档。