2013-06-24 103 views
1

我正在使用checkstyle來驗證項目的javadoc。我不想要任何checkstyle javadoc警告。配置Checkstyle以忽略一般警告

但是CheckStyle的是給我下面的不必要的警告做仿製藥:

預計爲 '< T>' @param標籤。

有沒有辦法可以關閉或禁止此特定警告?

我遇到過這樣做的唯一方法是壓制針對特定行的警告,我不想這樣做。

任何人都知道配置checkstyle忽略一般警告的方法嗎?

回答

0

您可以通過設置allowMissingParamTags屬性配置JavadocType檢查這種行爲true像這樣:

<module name="JavadocType"> 
    <property name="allowMissingParamTags" value="true"/> 
</module> 

在我的版本的Eclipse插件的CheckStyle(5.6.0.201209221626)的,這個選項是某種不存在在GUI(bug?)中,但可以通過直接編輯XML來設置它。

+1

感謝您的回覆。事實證明,我不需要這樣做,因爲我想看到錯誤畢竟。 但是出於好奇,如果我這樣做了,就像你建議將不會關閉所有缺少Javadoc標籤的警告?我仍然想看到所有其他缺少的param標籤。只是不是通用的。 你明白我來自哪裏嗎?也許這是不可能的? – Kevin

+0

@Kevin是的,這隻會影響你的泛型類型參數,因爲它設置在* JavadocType *檢查上,它不知道其他參數。 * JavadocMethod *不受影響(如果您使用泛型參數的方法,這可能是一個「問題」)。 –