JavaDoc Help


导航

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

页面类型

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

概述

概述页面是此API文档的首页,提供了所有模块的列表,并为每个模块提供摘要。此页面还可以包含一组模块的整体描述。

模块

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

  • 模块
  • 服务

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

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

类或接口

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

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

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

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

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

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

其他文件

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

用法

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

树(类层次结构)

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

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

预览API

预览API页面列出了所有预览API。预览API可能会在未来的实现中被移除。

新API

新API页面列出了最近发布的API。

已弃用的API

已弃用的API页面列出了所有已弃用的API。不推荐使用已弃用的API,通常是由于存在缺陷,通常会提供替代API。已弃用的API可能会在未来的实现中被移除。

常量字段值

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

序列化形式

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

系统属性

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

所有包

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

所有类和接口

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

索引

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


This help file applies to API documentation generated by the standard doclet.