「Java 編譯器 Javadoc」喜好設定

請在 開啟 Javadoc 喜好設定頁面 Java > 編譯器 > Javadoc 喜好設定頁面中,指出 Javadoc 設定的喜好設定。

選項

說明

預設值

處理 Javadoc 註解(包括搜尋和重新分解因素)

如果啟用這個選項,建置器會偵測到 Javadoc 註解中的問題。如果要在 Javadoc 註解上執行搜尋和重構,則也需要啟用這個選項。

開啟

形態異常的 Javadoc 註解

如果啟用,每當編譯器發現形態異常的 Javadoc 註解時,都會發出錯誤或警告。

忽略

只考量可見性如下的成員

編譯器只會檢查含指定或更寬可見性的成員。

Public

驗證標籤引數(@param、@throws、@exception、@see、@link)

如果啟用,每當編譯器在 Javadoc 註解標籤引數(@param、@throws、@exception、@see 或 @link)中發現錯誤時,都會發出錯誤或警告。

關閉

報告不可見的參照

當啟用時,每當編譯器發現指向不可見元素的參照時,都會發出錯誤或警告。

關閉

報告淘汰的參照

當啟用時,每當編譯器發現指向淘汰的參照時,都會發出錯誤或警告。

關閉

遺漏標籤說明

請選擇「驗證所有標準標籤」、「驗證 @return 標籤」或「忽略」。如果啟用,編譯器會在發現遺漏的標籤說明時,發出錯誤或警告。

驗證 @return 標籤

遺漏 Javadoc 標籤

當啟用時,每當編譯器發現遺漏的 Javadoc 標籤(也就是遺漏參數的 @param 標籤),編譯器都會發出錯誤和警告。

忽略

只考量可見性如下的成員

編譯器只會檢查含指定或更寬可見性的成員。

Public

在置換和實作方法中忽略

當啟用時,不會檢查置換或實作另一個方法的方法是否遺漏 Javadoc 標籤。

開啟

忽略方法類型參數

當啟用時,不會報告方法類型參數遺漏 Javadoc 標籤。

開啟

遺漏 Javadoc 註解

如果啟用,每當編譯器發現遺漏 Java 成員的 Javadoc 註解時,都會發出錯誤或警告。

忽略

只考量可見性如下的成員

編譯器只會檢查含指定或更寬可見性的成員。

Public

在置換和實作方法中忽略

當啟用時,不會檢查置換或實作另一個方法的方法是否遺漏 Javadoc 註解。

開啟