「API 錯誤和警告」喜好設定

可以使用 開啟「主控台」喜好設定頁面 開發外掛程式 > API 錯誤/警告喜好設定頁面來設定下列喜好設定。

在專案建置(自動及完整建置)期間會產生 API 問題,工具會將報告的問題類型細分為下列三大種類的其中之一:

  1. 使用問題 - 未獲授權的外掛程式呼叫受限的程式碼
  2. API 不相容 - 版本之間的變更不相容
  3. 版本問題 - 外掛程式版本或程式碼版本(@since 標籤)不正確
  4. 分析選項 - 一般選項

您也可以使用專案的 API 錯誤/警告內容頁面,來配置每個專案的問題嚴重性

API 用法

「API 用法」選項喜好設定頁面

一般項目

選項

說明

預設值

不支援使用 API Javadoc 標籤

當 API 分析建置器啟用後,會檢查是否有錯誤使用的 API Javadoc 標籤。

忽略

參照未定義在指定的執行環境中

當 API 分析建置器啟用後,會根據專為軟體組所指定的執行環境,檢查系統程式庫是否有無效參照。

忽略

限制

選項

說明

預設值

實作含有 '@noimplement' 標籤的介面

當 API 分析建置器啟用後,會檢查標示的介面是否有無效實作。

警告

延伸含有 '@noextend' 標籤的類型

當 API 分析建置器啟用後,會檢查是否有延伸標示類型的類別。

警告

參照含有 '@noreference' 標籤的欄位或方法

當 API 分析建置器啟用後,會檢查所標示的成員是否有欄位和方法參照。

警告

將含有 '@noinstantiate' 標籤的類別實例化

當 API 分析建置器啟用後,會檢查所標示的類別是否未實例化。

警告

置換含有 '@nooverride' 標籤的方法

當 API 分析建置器啟用後,會透過延伸(呼叫已置換的母類別來重新實作)或重新實作(不呼叫已置換的母類別),來檢查在子類別中沒有置換母類別中所標示的方法。

警告

洩漏

選項

說明

預設值

延伸非 API 類別

當 API 分析建置器啟用後,會檢查是否有 API 類別延伸非 API 類型。

警告

實作非 API 介面

當 API 分析建置器啟用後,會檢查是否有 API 類別實作非 API 介面

警告

含有非 API 類型的欄位

當 API 分析建置器啟用後,會檢查是否有任何 API 類型的公用或受保護欄位含有非 API 類型。

警告

含有非 API 傳回類型的方法

當 API 分析建置器啟用後,會檢查是否有任何 API 類型的公用或受保護方法含有非 API 傳回類型。

警告

含有非 API 參數類型的方法

當 API 分析建置器啟用後,會檢查是否有任何 API 類型的公用或受保護方法含有非 API 參數類型。

警告

API 相容性

「API 相容性」選項喜好設定頁面

選項

說明

預設值

即使獲得主要版本增量授權,還是報告 API 毀損

當 API 分析建置器啟用後,即使軟體組的主要版本已增量,還是會報告 API 毀損的問題。

已停用

軟體組

選項

說明

預設值

API 類型變成非 API

當 API 分析建置器啟用後,會檢查現行軟體組中是否有 API 類型已變更為非 API 類型。

錯誤

已移除類型

當 API 分析建置器啟用後,會檢查是否已從給定的軟體組中的 API 範圍移除了任何 API 類型。

錯誤

API 重新匯出的類型變成非 API

當 API 分析建置器啟用後,會檢查現行軟體組中是否有任何 API 重新匯出的類型變成非 API 類型。

錯誤

已移除重新匯出的類型

當 API 分析建置器啟用後,會檢查是否已從給定的軟體組中的 API 範圍移除了任何 API 重新匯出類型。

錯誤

類別

選項

說明

預設值

已新增方法(需要實作):

當 API 分析建置器啟用後,會檢查是否有需要實作的公用或受保護方法已新增至任何 API 類型。

錯誤

已新增限制

當 API 分析建置器啟用後,會檢查是否有 任何 API 類別新增了 API 限制。

錯誤

已新增類型參數

當 API 分析建置器啟用後,會檢查是否有任何類型參數新增至任何 API 類別。

錯誤

已減少超介面階層

當 API 分析建置器啟用後,會檢查是否已從任何 API 類別移除了母項介面。

錯誤

已新增關鍵字 'abstract'

當 API 分析建置器啟用後,會檢查是否有 'abstract' 關鍵字新增至任何 API 類別。

錯誤

已新增關鍵字 'final'

當 API 分析建置器啟用後,會檢查是否有 'final' 關鍵字新增至任何 API 類別。

錯誤

轉換成註釋、列舉或介面

當 API 分析建置器啟用後,會檢查是否有任何 API 類別變更為註釋、列舉或介面。

錯誤

已減少可見性

當 API 分析建置器啟用後,會檢查是否有任何公用 API 類別已成為專用或預設範圍。

錯誤

已移除欄位

當 API 分析建置器啟用後,會檢查是否已從任何 API 類別移除了公用或受保護欄位。

錯誤

已移除方法

當 API 分析建置器啟用後,會檢查是否已從任何 API 類別移除了公用或受保護方法。

錯誤

已移除建構子

當 API 分析建置器啟用後,會檢查是否已從任何 API 類別移除了公用或受保護建構子。

錯誤

已減少超類別階層

當 API 分析建置器啟用後,會檢查是否已從階層移除了超類別。

錯誤

已移除成員類型

當 API 分析建置器啟用後,會檢查是否已從任何 API 類別移除了成員類型。

錯誤

已移除類型參數

當 API 分析建置器啟用後,會檢查是否已從任何 API 類別移除了類型參數。

錯誤

介面

選項

說明

預設值

已新增欄位(不是標示為 '@noimplement' 的介面)

當 API 分析建置器啟用後,會檢查是否有公用欄位新增至任何 API 介面。

錯誤

已新增方法(不是標示為 '@noimplement' 的介面)

當 API 分析建置器啟用後,會檢查是否有公用方法新增至任何 API 介面。

錯誤

已新增限制

當 API 分析建置器啟用後,會檢查是否有任何 API 介面新增 API 限制。

錯誤

已新增類型參數

當 API 分析建置器啟用後,會檢查是否有類型參數新增至任何 API 介面。

錯誤

轉換成類別、列舉或註釋

當 API 分析建置器啟用後,會檢查是否有 API 介面變更為類別、列舉或介面。

錯誤

已減少超介面階層

當 API 分析建置器啟用後,會檢查是否已從任何 API 介面移除了母項介面。

錯誤

已移除類型參數

當 API 分析建置器啟用後,會檢查是否已從任何 API 介面移除了類型參數。

錯誤

已移除欄位

當 API 分析建置器啟用後,會檢查是否已從任何 API 介面移除了公用欄位。

錯誤

已移除方法

當 API 分析建置器啟用後,會檢查是否已從任何 API 介面移除了公用方法。

錯誤

已移除成員類型

當 API 分析建置器啟用後,會檢查是否已從任何 API 介面移除了成員類型。

錯誤

列舉

選項

說明

預設值

已減少超介面階層

當 API 分析建置器啟用後,會檢查是否已從任何 API 列舉移除了母項介面。

錯誤

轉換成註釋、類別或介面

當 API 分析建置器啟用後,會檢查是否有 API 列舉變更為註釋、類別或介面。

錯誤

已移除欄位

當 API 分析建置器啟用後,會檢查是否已從任何 API 列舉移除了公用欄位。

錯誤

已移除列舉常數

當 API 分析建置器啟用後,會檢查是否已從任何 API 列舉移除了列舉常數。

錯誤

已移除方法

當 API 分析建置器啟用後,會檢查是否已從任何 API 列舉移除了公用方法。

錯誤

已移除成員類型

當 API 分析建置器啟用後,會檢查是否已從任何 API 列舉移除了成員類型。

錯誤

註釋

選項

說明

預設值

已新增無預設值的方法

當 API 分析建置器啟用後,會檢查是否有無預設值的方法新增至 API 註釋。

錯誤

轉換成類別、列舉或介面

當 API 分析建置器啟用後,會檢查是否有 API 註釋轉換成類別、列舉或介面。

錯誤

已移除欄位

當 API 分析建置器啟用後,會檢查是否已從任何 API 註釋移除了公用欄位。

錯誤

已移除方法

當 API 分析建置器啟用後,會檢查是否已從任何 API 註釋移除了公用方法。

錯誤

已移除成員類型

當 API 分析建置器啟用後,會檢查是否已從任何 API 註釋移除了公用成員類型。

錯誤

欄位

選項

說明

預設值

已新增常數值

當 API 分析建置器啟用後,會檢查是否有常數值新增至任何 API 類型先前未起始設定的公用或受保護欄位常數。

錯誤

已修改類型

當 API 分析建置器啟用後,會檢查是否有任何 API 類型變更了公用或受保護欄位的類型。

錯誤

已修改常數值

當 API 分析建置器啟用後,會檢查任何 API 類型中是否變更了公用或受保護欄位常數的值。

錯誤

已減少可見性

當 API 分析建置器啟用後,會檢查任何 API 類型中是否有任何公用或受保護欄位變成專用。

錯誤

已移除靜態常數的關鍵字 'final'

當 API 分析建置器啟用後,會檢查任何 API 類型中是否有任何公用或受保護欄位移除了 'final' 關鍵字。

錯誤

已新增關鍵字 'final'

當 API 分析建置器啟用後,會檢查任何 API 類型中是否有 'final' 關鍵字新增至公用或受保護欄位。

錯誤

已移除關鍵字 'static'

當 API 分析建置器啟用後,會檢查任何 API 類型中是否有從公用或受保護欄位移除 'static' 關鍵字。

錯誤

已新增關鍵字 'static'

當 API 分析建置器啟用後,會檢查任何 API 類型中是否有 'static' 關鍵字新增至公用或受保護欄位。

錯誤

已移除常數值

當 API 分析建置器啟用後,會檢查任何 API 類型中是否從任何公用或受保護欄位中移除了常數欄位的值。

錯誤

已移除類型引數

當 API 分析建置器啟用後,會檢查任何 API 類型中是否有從公用或受保護欄位移除類型引數。

錯誤

方法

選項

說明

預設值

已新增 @nooverride 限制

當 API 分析建置器啟用後,會檢查任何 API 類型中是否有透過新增 @nooverride 標籤而變更任何公用或受保護方法的限制。

錯誤

已新增類型參數

當 API 分析建置器啟用後,會檢查任何 API 類型中是否有類型參數新增至公用或受保護方法。

錯誤

已將可變引數轉換成陣列類型

當 API 分析建置器啟用後,會檢查是否有varargs 引數展開為任何 API 類型的公用或受保護方法的物件陣列。

錯誤

已減少可見性

當 API 分析建置器啟用後,會檢查任何 API 類型是否有將公用或受保護方法變成專用。

錯誤

已新增關鍵字 'abstract'

當 API 分析建置器啟用後,會檢查任何 API 類型中是否有將公用或受保護方法變成抽象。

錯誤

已新增關鍵字 'static'

當 API 分析建置器啟用後,會檢查任何 API 類型中是否有公用或受保護方法變成靜態。

錯誤

已移除關鍵字 'static'

當 API 分析建置器啟用後,會檢查任何 API 類型中是否有將公用或受保護方法變成非靜態。

錯誤

已新增關鍵字 'final'(標示 '@noextend' 的類型)

當 API 分析建置器啟用後,會檢查在標示 @noextend 的任何 API 類型中是否有公用或受保護方法變成最終。

錯誤

已移除註釋預設值

當 API 分析建置器啟用後,會檢查是否已移除與任何 API 註釋方法相關聯的預設值。

錯誤

已移除類型參數

當 API 分析建置器啟用後,會檢查是否已從任何 API 類型的公用或受保護方法移除了類型參數。

錯誤

建構子

選項

說明

預設值

已新增類型參數

當 API 分析建置器啟用後,會檢查是否有類型參數新增至任何 API 類型的公用建構子。

錯誤

已將可變引數轉換成陣列類型

當 API 分析建置器啟用後,會檢查是否有任何 varargs 參數展開為任何 API 類型的公用建構子的物件陣列。

錯誤

已減少可見性

當 API 分析建置器啟用後,會檢查任何 API 類型中是否有公用建構子變成非公用。

錯誤

已移除類型參數

當 API 分析建置器啟用後,會檢查是否已從任何 API 類型的公用建構子移除了類型參數。

錯誤

類型參數

選項

說明

預設值

已新增類別範圍

當 API 分析建置器啟用後,會檢查是否有類別範圍新增至任何 API 類型的類型參數。

錯誤

已新增介面範圍

當 API 分析建置器啟用後,會檢查是否有介面範圍新增至任何 API 類型的類型參數。

錯誤

已修改類別範圍

當 API 分析建置器啟用後,會檢查是否有任何 API 類型的類型參數已變更類別範圍。

錯誤

已修改介面範圍

當 API 分析建置器啟用後,會檢查是否有任何 API 類型的類型參數已變更介面範圍。

錯誤

已移除類別範圍

當 API 分析建置器啟用後,會檢查是否已從任何 API 類型的類型參數移除了類別範圍。

錯誤

已移除介面範圍

當 API 分析建置器啟用後,會檢查是否已從任何 API 類型的類型參數移除了介面範圍。

錯誤

版本管理

「API 版本管理」選項喜好設定頁面

選項

說明

預設值

報告遺漏 '@since' 標籤

當 API 分析建置器啟用後,會檢查自從使用 API 基準線版本之後新增的類型或成員是否遺漏 @since 標籤。

錯誤

報告形態異常的 '@since' 標籤

當 API 分析建置器啟用後,會檢查目前使用中的任何 @since 標籤是否形態異常(不正確語法)。

錯誤

報告無效的 '@since' 標籤版本

當 API 分析建置器啟用後,會檢查目前使用中的任何 @since 標籤是否有錯誤版本。

錯誤

報告不相容的軟體組版本

當 API 分析建置器啟用後,會根據任何 API 變更和目前使用中的 API 基準線,檢查外掛程式的軟體組版本是否不正確。

錯誤

無 API 變更之下忽略次要版本增量

如果已啟用報告不相容版本號碼的功能,您可以使用這個選項來告知 API 分析建置器,若對照現行 API 基準線之後並無 API 變更,則忽略次要版本變更。

開啟

無 API 變更之下忽略主要版本增量

如果已啟用報告不相容版本號碼的功能,您可使用這個選項來告知 API 分析建置器,若對照現行 API 基準線之後並無 API 變更,則忽略主要版本變更。

開啟

分析選項

「分析」選項喜好設定頁面

選項

說明

預設值

軟體組遺漏必要的限制項/必備項目

當 API 分析建置器啟用後,會報告使建置器無法執行完整分析的任何遺漏的必要限制項或必備項目。無論這個選項的值為何,都會略過對應軟體組的這項分析。

錯誤

未用的 API 問題過濾器

當啟用時,API 分析建置器會報告任何已不再使用的 API 問題過濾器。

警告

API 用法掃描選項

「API 用法掃描選項」喜好設定頁面

選項

說明

預設值

未解析的類型問題

當啟用時,API 分析建置器會報告包含在 API 用法掃描喜好設定頁面所列出的任何使用掃描中,但已被移除的任何 API 類型。

錯誤

未解析的方法問題

當啟用時,API 分析建置器會報告包含在 API 用法掃描喜好設定頁面所列出的任何使用掃描中,但已被移除的任何方法。

錯誤

未解析的欄位問題

當啟用時,API 分析建置器會報告包含在 API 用法掃描喜好設定頁面所列出的任何使用掃描中,但已被移除的任何欄位。

錯誤


相關參照

PDE 喜好設定
API 錯誤和警告內容頁面
API 基準線喜好設定
API 用法掃描喜好設定