JavaDoc 說明


導覽

概觀頁面開始,您可以透過每個頁面中的連結以及每個頁面頂端的導覽列來瀏覽文件。索引和搜尋框允許您導覽至特定宣告和摘要頁面,包括:所有套件所有類別與介面

頁面種類

以下章節描述此集合中不同種類的頁面。

概觀

概觀頁面是此 API 文件的首頁,並提供所有套件的列表以及每個套件的摘要。此頁面還可以包含套件集合的整體描述。

套件

每個套件都有一個頁面,其中包含其類別和介面的列表,以及每個類別和介面的摘要。這些頁面可能包含以下類別

  • 介面
  • 類別
  • 列舉
  • 例外類別
  • 註解類型

類別或介面

每個類別、介面、巢狀類別和巢狀介面都有其各自獨立的頁面。這些頁面中的每一個都有三個部分組成:宣告和描述、成員摘要表,以及詳細的成員描述。如果每個部分中的條目為空或不適用,則會省略。

  • 類別繼承圖
  • 直接子類別
  • 所有已知的子介面
  • 所有已知的實作類別
  • 類別或介面宣告
  • 類別或介面描述

  • 巢狀類別摘要
  • 列舉常數摘要
  • 欄位摘要
  • 屬性摘要
  • 建構子摘要
  • 方法摘要
  • 必要元素摘要
  • 選用元素摘要

  • 列舉常數詳細資訊
  • 欄位詳細資訊
  • 屬性詳細資訊
  • 建構子詳細資訊
  • 方法詳細資訊
  • 元素詳細資訊

注意: 註解介面具有必要和選用元素,但沒有方法。只有列舉類別具有列舉常數。record 類別的組件會顯示為 record 類別宣告的一部分。屬性是 JavaFX 的一項功能。

摘要條目按字母順序排列,而詳細描述則按照它們在原始碼中出現的順序排列。這保留了程式設計師建立的邏輯分組。

其他檔案

套件和模組可能包含帶有與附近宣告相關之額外資訊的頁面。

樹狀結構 (類別階層)

有一個 類別階層 頁面適用於所有套件,以及每個套件的階層。每個階層頁面都包含類別列表和介面列表。類別依繼承結構組織,從 java.lang.Object 開始。介面不繼承自 java.lang.Object

  • 當檢視概觀頁面時,按一下 TREE 會顯示所有套件的階層。
  • 當檢視特定套件、類別或介面頁面時,按一下 TREE 會顯示僅該套件的階層。

已過時的 API

已過時的 API 頁面列出所有已過時的 API。通常由於缺點,不建議使用已過時的 API,並且通常會提供替代的 API。已過時的 API 可能會在未來的實作中移除。

已序列化表單

每個可序列化或可外部化的類別都有其序列化欄位和方法的描述。此資訊對於實作 API 而非使用 API 的人來說很有用。雖然導覽列中沒有連結,但您可以透過前往任何序列化類別並按一下類別描述「另請參閱」部分中的「已序列化表單」來取得此資訊。

所有套件

所有套件 頁面包含文件中所有套件的字母索引。

所有類別與介面

所有類別與介面 頁面包含文件中所有類別和介面的字母索引,包括註解介面、列舉類別和 record 類別。

索引

索引 包含文件中所有類別、介面、建構子、方法和欄位的字母索引,以及摘要頁面,例如 所有套件所有類別與介面


此說明檔案適用於由標準 doclet 產生的 API 文件。