定義 API 限制

「API 工具」提供 Javadoc 標籤來明確記錄及限制 API 的使用。下列表格彙總每一個成員所支援的 Javadoc 標籤以及每一個標籤的語意。

client 是指需要定義了關聯 API 的軟體組的外掛程式或軟體組。限制不適用於定義了 API 的相同軟體組。例如,將介面定義為 @noimplement 的軟體組也可以提供該介面的實作。

支援的限制標籤

  類別 介面 方法 建構子

最終欄位

非最終欄位
@noimplement
-
支援
-
-
-
-
@noextend
支援
支援
-
-
-
-
@noinstantiate
支援
-
-
-
-
-
@nooverride
-
-
支援
-
-
-
@noreference
-
-
支援
支援
-
支援

限制語意

@noimplement

指出用戶端不得實作此介面。任何類別若對於沒有實作超類別的關聯介面或關聯介面的母項使用implements 關鍵字,將標示為有問題。

@noextend
指出用戶端不得延伸這個類別或介面。任何對關聯類型使用 extends 關鍵字的類別或介面,將標示為有問題。
@noinstantiate
指出用戶端不得將這個類別實例化。使用任何建構子將關聯類別實例化的任何程式碼,將標示為有問題。
@nooverride
指出用戶端不得重新宣告這個方法。任何子類別若定義的方法會置換關聯方法,將標示為有問題。
@noreference
指出用戶端不得參照這個方法、建構子或非最終欄位。若程式碼直接呼叫關聯方法或建構子,或參照關聯的非最終欄位,將標示為有問題。

相關作業

設定基準線

相關參照

Javadoc @since 標籤管理
API 基準線喜好設定
「API 錯誤和警告」喜好設定