Java文档帮助


导航

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

页面种类

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

概述

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

Module

每个模块都有一个页面,其中包含其包列表、对其他模块的依赖项和服务,以及每个模块的摘要。这些页面可能包含以下类别:

  • 模块
  • 服务

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

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

类或接口

每个类、接口、内部类和嵌套接口都有自己独立的页面。这些页面中的每一页都包含三个部分,包括声明和描述、成员汇总表和详细的成员描述。如果这些部分为空或不适用,则这些部分中的条目将被省略。

  • 类层级图
  • 直接子类
  • 所有已知的子接口
  • 所有已知的实现类
  • 类或者接口声明
  • 类或接口说明

  • 内部类总结
  • 枚举常量总结
  • 字段摘要
  • 属性概要
  • 构造方法总结
  • 方法总结
  • 必需元素摘要
  • 可选元素摘要

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

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

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

其他文件

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

使用

每个文档化的包、类和接口都有自己的使用页面。此页面描述了哪些包、类、方法、构造方法和字段使用给定类或包的任何部分。给定一个类或接口A,其使用页面包括A的子类、声明为A的字段、返回A的方法以及参数类型为A的方法和构造方法。您可以通过首先进入包、类或接口来访问该页面,然后单击导航栏中的 USE 链接。

树(类层次结构)

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

  • 查看概览页面时,单击 TREE 会显示所有包的层次结构。
  • 查看特定包、类或接口页面时,单击 TREE 仅显示该包的层次结构。

预览API

预览API 页面列出了所有预览版 API。在未来的实施中可能会删除预览 API。

新API

新API 页面列出了最近版本中添加的 API。

已弃用的 API

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

常量字段值

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

Serialized Form

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

系统属性

系统属性 页面列出了对系统属性的引用。

所有包

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

所有类和接口

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

索引

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


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