2017-04-05 89 views
1

可以創建一個自定義註釋來強制一個方法擁有一個javadoc?Java註釋強制寫javadoc

我想創建一個註釋,檢查方法是否遵循特定的規則。我無法理解如何檢查javadoc。

任何人都可以幫助我嗎?

+0

有一些工具可以查找丟失的javadoc,但是沒有任何東西可以被強制使用(除非你在你的開發者上使用了一些棒:p) – 2017-04-05 11:57:36

+0

是你監控你的源代碼嗎?你在用什麼IDE? –

+0

我想,如果該方法不遵循規則,那麼javac將在方法中使用該註釋使編譯失敗。 –

回答

3

您可以使用checkstyle來檢查包含javadoc的方法。

+0

你可以給我一個自定義註釋與checkstyle lib的例子嗎? –

+0

您不要創建自定義註釋。 Checkstyle是一種用於檢查源代碼質量的工具。它可以執行的檢查之一是檢查你的方法是否包含javadoc。 –

1

如果您正在使用的Eclipse IDE,那麼你可以設置,如果沒有的Javadoc檢測到的顯示錯誤編譯器標誌(使用該小心,因爲這是非常詳細!)..

enter image description here