API 用法報告

API 用法報告說明某組軟體組對另一組軟體組的參照集。您可以使用 API 用法 Ant 作業來產生報告。所提供的使用者介面可讓您在外部工具對話框中,配置與產生報告。如果要建立新的用法掃描配置,只需按兩下 API 用法報告配置類型即可。

「API 用法報告」標籤

API 用法報告標籤可讓您配置分析。

下列範例顯示的配置是擷取 3.4 安裝架構中之 Eclipse 軟體組的所有參照。

「API 用法報告」標籤


選項

說明

預設值

分析 您可以選取要分析的項目,這可以是 API 基準線、目標定義,或是軟體組目錄。您也可以選取只產生現有報告的 HTML。您只能選取一個選項,且每個選項都可供您配置。亦即,如果您選取分析 API 基準線,則可以移至 API 基準線喜好設定頁面,以編輯現有的基準線。 API 基準線
分析 > API 基準線 您可以從組合框中,選取任何要分析的 API 基準線 預設基準線或空白
分析 > 基準線... 容許存取 API 基準線喜好設定頁面,以配置要分析的基準線。  
分析 > 目標定義 您可以從組合框中,選取任何要分析的目標定義 作用中目標定義或空的
分析 > 目標 容許存取目標平台喜好設定頁面,以配置要分析的目標定義。  
分析 > 目錄 您可以輸入含有軟體組之目錄的絕對路徑。 空的
分析 > 瀏覽... 可讓您瀏覽找出要分析之軟體組的資料夾。  
分析 > 產生現有用法掃描的 HTML 報告 可讓您針對現有的掃描建立報告,且不需重新執行分析。  
搜尋目標 > 參照至 可讓您指定您要查看參照所指向的軟體組名稱(或相符的 RegEx)。請考量下列範例:org\.eclipse.*。本例假設我們想查看以 org.eclipse. 名稱開頭之任何軟體組的所有參照。 空的
搜尋目標 > API 參照 可讓您掃描找出 API 參照。 unchecked
搜尋目標 > 內部參照 可讓您掃描找出內部參照。 已勾選
搜尋目標 > 無效的 API 用法 可讓您掃描找出無效的 API 用法,亦即,受限 API 成員的用法。 unchecked
搜尋位置 > 軟體組相符 可讓您指定您要從中(亦即,搜尋範圍)掃描找出參照的軟體組名稱(或相符的 RegEx)。 請考量下列範例:.*。本例假設我們想在其名稱符合任何字元順序的所有軟體組中進行搜尋。將欄位留白,也可以達到相同的效果。 空的
產生報告 > 報告類型 可讓您在兩種 HTML 報告格式之間選擇。 如果選取被參照的軟體組報告(生產者),報告會列出所有包含被搜尋的軟體組所參照之類型的軟體組。 如果選取參照的軟體組報告(使用端),就會組織報告來顯示搜尋範圍內,所有包含參照的軟體組。

當切換報告類型時,請確認參照目標和軟體組相符正規表示式有正確的值。 當在一項設定中使用 .* 之類的萬用字元表示式,在切換至另一個報告類型時,通常會要求將萬用字元移至其他設定中,以得到最有用的報告。

被參照的軟體組報告(生產者)
產生報告 > 報告輸出位置 可讓您指定應用來放置任何產生的報告的絕對路徑。 空的
產生報告 > 瀏覽... 可讓您選取任何報告的輸出位置。  
產生報告 > 報告新結果之前先清除報告目錄 可讓您在掃描產生任何結果的報告之前,先清理現有的 XML 報告位置。要注意的是,這個選項會完全移除指定的報告目錄(如果存在的話),並且遞迴地移除其所有的子目錄。 unchecked
產生報告 > 建立 HTML 報告 將所有的 XML 輸出轉換成格式化 HTML,並將它放在 <report location>\html 中 unchecked
產生報告 > 清除 HTML 報告位置 可讓您在建立新報告之前,先清理現有的 HTML 位置。要注意的是,這個選項會完全移除指定的 HTML 目錄(如果存在的話),並且遞迴地移除其所有的子目錄。只有在您選取上述的建立 HTML 報告選項時,才會啟用這個選項。 unchecked
產生報告 > 搜尋完成時開啟報告 分析完成時,開啟 HTML 報告。只有在您選取上述的建立 HTML 報告選項時,才會啟用這個選項。 unchecked
產生報告 > 說明 讓您輸入可讀的報告說明。 空的

「型樣」標籤

型樣標籤可讓您建立各種不同的「正規表示式」型樣,來控制用法分析。目前支援的型樣有下列三種:

  1. 保存檔型樣 - 可讓您指定分析期間應忽略的巢狀保存檔。
  2. 套件型樣 - 可讓您指定必須是 API 或內部型樣的套件,而不需要更新軟體組資訊清單。
  3. 報告轉換型樣 - 可讓您建立套件名稱正規表示式,來過濾所要報告的參照。這會使用其完整的套件名稱,來過濾所有要報告的參照。

「型樣」標籤


選項

說明

預設值

新增... 可讓您新增型樣。這個按鈕會啟動「型樣」精靈。  
編輯 可讓您編輯目前選取的型樣。一次只能編輯一個型樣。  
移除 可讓您移除選取的型樣。您可以一次移除多個型樣。  

相關作業

和 API 基準線比較
設定基準線

相關參照

API 基準線喜好設定
API 用法型樣精靈