JavaDoc 帮助

搜索

您可以搜索 API 中定义的模块、程序包、类型、字段、方法、系统属性和其他术语的定义。可以使用名称的一部分或全部搜索这些项目，可以选择使用“驼峰式”缩写，或用空格分隔的多个搜索词。一些例子

1. "j.l.obj" 匹配 "java.lang.Object"
2. "InpStr" 匹配 "java.io.InputStream"
3. "math exact long" 匹配 "java.lang.Math.absExact(long)"

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

概述

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

程序包

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

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

类或接口

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

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

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

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

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

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

其他文件

程序包和模块可能包含页面，其中包含与附近声明相关的其他信息。

树 (类层次结构)

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

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

弃用的 API

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

序列化形式

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

所有程序包

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

所有类和接口

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

索引

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