JavaDoc帮助

• 导航:
  • 搜索
• 页面类型:
  • 概述
  • 包
  • 类或接口
  • 其他文件
  • 使用
  • 树 (类层次结构)
  • 已过时的API
  • 常量字段值
  • 序列化形式
  • 所有包
  • 所有类和接口
  • 索引

导航

从概述页面开始，您可以使用每个页面中的链接以及每个页面顶部的导航栏来浏览文档。索引和搜索框允许您导航到特定的声明和摘要页面，包括：所有包，所有类和接口

搜索

您可以使用名称的部分或全部（可以选择使用“驼峰式”缩写）搜索API中定义的模块、包、类型、字段、方法、系统属性和其他术语的定义。例如

• j.l.obj 将匹配 "java.lang.Object"
• InpStr 将匹配 "java.io.InputStream"
• HM.cK 将匹配 "java.util.HashMap.containsKey(Object)"

有关搜索功能的完整描述，请参阅Javadoc搜索规范。

页面类型

以下部分描述了此集合中不同类型的页面。

概述

概述页面是此API文档的首页，并提供所有包的列表以及每个包的摘要。此页面还可以包含包集的总体描述。

包

每个包都有一个页面，其中包含其类和接口的列表，以及每个类和接口的摘要。这些页面可能包含以下类别

• 接口
• 类
• 枚举
• 异常
• 错误
• 注解类型

类或接口

每个类、接口、嵌套类和嵌套接口都有其自己单独的页面。 这些页面中的每一个都有三个部分，包括声明和描述、成员摘要表以及详细的成员描述。如果每个部分中的条目为空或不适用，则将其省略。

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

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

• 枚举常量详细信息
• 字段详细信息
• 属性详细信息
• 构造函数详细信息
• 方法详细信息
• 元素详细信息

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

摘要条目按字母顺序排列，而详细描述按它们在源代码中出现的顺序排列。 这样可以保留程序员建立的逻辑分组。

其他文件

包和模块可能包含与附近声明相关的附加信息的页面。

使用

每个已记录的包、类和接口都有其自己的“使用”页面。此页面描述了哪些包、类、方法、构造函数和字段使用了给定类或包的任何部分。给定一个类或接口A，其“使用”页面包括A的子类，声明为A的字段，返回A的方法，以及具有A类型参数的方法和构造函数。您可以通过首先转到包、类或接口，然后单击导航栏中的“使用”链接来访问此页面。

树 (类层次结构)

有一个针对所有包的类层次结构页面，以及每个包的层次结构。每个层次结构页面都包含一个类列表和一个接口列表。类按继承结构组织，从java.lang.Object开始。接口不继承自java.lang.Object。

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

已过时的API

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

常量字段值

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

序列化形式

每个可序列化或可外部化类都对其序列化字段和方法进行描述。 此信息对实现API而不是使用API的人员感兴趣。 虽然导航栏中没有链接，但您可以转到任何序列化的类，然后单击类描述的“另请参阅”部分中的“序列化形式”来获取此信息。

所有包

所有包页面包含文档中包含的所有包的字母索引。

所有类和接口

所有类和接口页面包含文档中包含的所有类和接口的字母索引，包括注解接口、枚举类和记录类。

索引

索引包含文档中所有类、接口、构造函数、方法和字段的字母索引，以及摘要页面，例如所有包，所有类和接口。

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