此 API 文档的组织方式

该 API(应用程序编程接口)文档有与导航栏中的项目对应的页面,描述如下。

包裹

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

  • 接口
  • 课程
  • 枚举
  • 例外
  • 错误
  • 注释类型

类或接口

每个类、接口、嵌套类和嵌套接口都有自己独立的页面。这些页面中的每一个都包含三个部分,包括类/接口描述、摘要表和详细的成员描述:

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

  • 嵌套类摘要
  • 字段摘要
  • 属性摘要
  • 构造函数摘要
  • 方法总结

  • 字段详细信息
  • 物业详情
  • 构造函数详细信息
  • 方法详情

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

注释类型

每种注释类型都有自己的单独页面,包含以下部分:

  • 注释类型声明
  • 注释类型描述
  • 所需元素摘要
  • 可选元素摘要
  • 元素详细信息

枚举

每个枚举都有自己的单独页面,包含以下部分:

  • 枚举声明
  • 枚举描述
  • 枚举常量摘要
  • 枚举常量详细信息

采用

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

树(类层次结构)

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

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

已弃用的 API

弃用的 API页面列出了所有已弃用的 API。不推荐使用已弃用的 API,一般是由于缺点,通常会给出替换 API。在未来的实现中可能会删除不推荐使用的 API。

指数

索引包含所有类、接口、构造函数、方法和字段的字母索引,以及所有包和所有类的列表。

序列化表格

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

常量字段值

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

搜索

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

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

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


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