此 API 文档的组织方式

此 API(应用程序编程接口)文档具有与导航栏中的项对应的页面,如下所述。
  • 概述

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

  • 打包

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

    • 接口 (斜体)
    • 枚举
    • 异常
    • 错误
    • 注释类型
  • 类/接口

    每个类、接口、嵌套类和嵌套接口都有自己的单独页面。 其中每个页面都有三个部分,由类/接口描述、摘要表和详细成员描述组成:

    • 类继承图
    • 直接子类
    • 所有已知子接口
    • 所有已知实现类
    • 类/接口声明
    • 类/接口描述
    • 嵌套类摘要
    • 字段摘要
    • 构造函数摘要
    • 方法概要
    • 字段详细信息
    • 构造函数详细信息
    • 方法详细信息

    每个摘要条目都包含该项的详细描述中的第一句。 摘要条目按字母顺序排列,而详细描述按它们在源代码中的显示顺序排列。 这将保留程序员建立的逻辑分组。

  • 注释类型

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

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

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

    • 枚举声明
    • 枚举描述
    • 枚举常量摘要
    • 枚举常量详细信息
  • 树(类层次结构)

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

    • 查看“概述”页面时,单击“树”将显示所有数据包的层次结构。
    • 查看特定包,类或接口页面时,单击 "树" 将仅显示该包的层次结构。
  • 不推荐使用的 API

    " 不推荐使用的 API " 页面列出了已不推荐使用的所有 API。 建议不要使用不推荐的 API,通常是由于改进,并且通常会提供替代 API。 在将来的实现中可能会移除不推荐使用的 API。

  • 索引

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

  • 上一个/下一个

    这些链接可将您转至下一个或上一个类,接口,包或相关页面。

  • 帧数/无帧数

    这些链接显示和隐藏 HTML 框架。 所有页面都可与框架一起使用或不与框架一起使用。

  • 所有类

    所有类 链接显示除非静态嵌套类型以外的所有类和接口。

  • 序列化表单

    每个可序列化或可外部化类都具有其序列化字段和方法的描述。 重新实现者(而不是使用 API 的开发者)需要此信息。 虽然导航栏中没有链接,但您可以通过转至任何序列化类并单击类描述的“另请参阅”部分中的“序列化表单”来获取此信息。

  • 常量字段值

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

此帮助文件适用于使用标准 doclet 生成的 API 文档。
© Copyright IBM Corp. 2008 , 2016. All Rights Reserved.