JavaDoc 說明

導覽

從概觀頁面開始，您可以使用每個頁面中的連結以及每個頁面頂部的導覽列來瀏覽文件。索引和搜尋框可讓您導覽至特定的宣告和摘要頁面，包括：所有套件、所有類別與介面

頁面種類

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

概觀

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

套件

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

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

類別或介面

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

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

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

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

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

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

其他檔案

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

使用

每個有文件的套件、類別和介面都有其自己的「使用」頁面。此頁面描述哪些套件、類別、方法、建構子和欄位使用給定類別或套件的任何部分。給定類別或介面 A，其「使用」頁面包括 A 的子類別、宣告為 A 的欄位、傳回 A 的方法，以及具有 A 類型參數的方法和建構子。您可以先前往套件、類別或介面，然後點擊導覽列中的「USE」連結來存取此頁面。

樹狀結構 (類別階層)

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

  • 當查看「概觀」頁面時，點擊「樹狀結構」會顯示所有套件的階層。
  • 當查看特定套件、類別或介面頁面時，點擊「樹狀結構」只會顯示該套件的階層。

已過時的 API

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

常數欄位值

常數欄位值頁面列出靜態 final 欄位及其值。

序列化形式

每個可序列化或外部化的類別都有其序列化欄位和方法的描述。此資訊對於實作而非使用 API 的人來說很有用。雖然導覽列中沒有連結，但您可以前往任何序列化的類別，然後點擊類別描述的「參見」部分中的「序列化形式」來取得此資訊。

所有套件

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

所有類別與介面

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

索引

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

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