如何忽略具有特定註釋的方法的checkstyle javadoc警告

Question

當我有一個沒有javadoc的公共方法時，Checkstyle會發出警告，這很好！當我重寫公共方法時，我不會收到警告，因爲javadoc已經在方法的父類中可用。

現在我對我的方法有其他註釋，例如@MyEvent。現在我確實得到了警告，但不想要它，因爲註釋足夠了。我可以排除具有特定註釋的方法的警告嗎？

有一些解決方案涉及到像我的代碼@SuppressWarnings或像// CHECKSTYLE.OFF這樣的評論添加東西，但這不會使我的代碼更好，我可以只是添加javadoc。所以我正在尋找配置級解決方案。

Answer 1

我可以排除具有特定註釋的方法的警告嗎？

您可以通過使用一個特定的註解（@SuppressWarnings）禁止警告，但其他註釋不能使用該效果（如@MyEvent）。

至少不是開箱即用的。如果你願意做一些編程，你可以開發自己的custom filter，它可以滿足你的需求。