「API 用法型樣」精靈

這個精靈的說明會引導您建立正規表示式型樣,以控制「API 用法」分析。

如果要啟動精靈,請使用下列步驟:

  1. 建立新的「API 用法報告」啟動配置時,請切換至型樣標籤。
  2. 在標籤中,按下新增... 按鈕

選項

說明

預設值

型樣類型 此清單顯示可以使用精靈來建立的所有型樣。 清單中的第一個元素
說明 顯示您在型樣類型清單中所選取型樣類型的可讀說明。  

精靈的首頁可讓您選取要建立的型樣類型。會提供每一種型樣的說明,來協助您選擇 - 您只需選取型樣,其說明會顯示在說明欄位中。

「API 用法型樣」精靈 - 型樣選擇頁面

保存檔型樣

完成 API 用法分析時,會掃描軟體組中的所有資料夾與保存檔;這可確保所有的類別檔皆已分析。在某些情況下,軟體組中的保存檔可能含有您不想分析的項目,例如,舊版的類別檔。在此情況下,可以使用保存檔型樣來完全忽略特定保存檔或符合給定正規表示式的所有保存檔。

選項

說明

預設值

軟體組名稱 要套用這個型樣之軟體組的完整符號名稱。例如:org.eclipse.pde.api.tools。 空的
保存檔名稱 要套用該型樣之保存檔的完整名稱或正規表示式。例如 *.jar - 這會忽略任何巢狀 JAR 檔。 空的

「API 用法型樣」精靈 - 建立保存檔型樣

套件型樣

當擷取參照來分析時,「API 用法」搜尋引擎會使用軟體組中的 meta 資料,來判斷是否為內部參照。在某些情況下,並未設定軟體組來適當說明哪些類別是內部,哪些不是。套件型樣可讓您擴增這些形態異常的軟體組 - 只從搜尋引擎的觀點,不會以任何方式來變更實際的軟體組 - 來說明哪些是內部,哪些不是。

選項

說明

預設值

型樣 要用來比對套件的正規表示式型樣。 例如:.*\.internal\..*。 空的
API 型樣 型樣是否應將相符的套件視為 API。 已勾選

「API 用法型樣」精靈 - 建立套件型樣

報告轉換型樣

API 用法分析完成時,要仔細查看的資訊量可能很大。利用報告轉換型樣,就可以減少呈現在 HTML 報告中的參照資訊,僅查看您有興趣的內容。如果要執行這項作業,您可以建立排除型樣,以用來刪改所報告的參照。

選項

說明

預設值

過濾指向這個型樣的參照 可讓您忽略報告指向型樣的參照。 例如,如果型樣是 org\.eclipse\.jdt\..*,選取這個選項時,就不會報告指向 JDT 的任何參照。 已選取
過濾來自這個型樣的參照 可讓您忽略報告指向型樣的參照。 例如,如果型樣是 org\.eclipse\.jdt\..*,選取這個選項時,就不會報告由 JDT 發出的任何參照。  
型樣 正規表示式型樣。 空的

「API 用法型樣」精靈 - 建立報告轉換型樣

相關作業

設定 API 工具

相關參照

API 工具設定動作
PDE 工具功能表
API 用法報告