如何強制團隊成員使用eclipse插件或其他東西發表評論

Question

目前，我正在一個新項目中工作，由於沒有評論，我很難理解。我想知道是否有可能迫使團隊成員（包括我）增加更多評論。如果可能的話，我想在jenkins中自動化這個項目。

Answer 1

您可以運行靜態代碼檢查及其相應的eclipse插件來強制執行代碼中的註釋。

例如，在CheckStyle javadoc中可以強制執行http://checkstyle.sourceforge.net/config_javadoc.html

另外checkstyle可以很容易地與Jenkins集成。

您還可以使用eclipse java編譯器設置進行javadoc檢查。

轉到preferences-> java-> compiler-> javadoc來執行錯誤和警告。 編譯器錯誤和警告，可以通過持續構建

歡呼聲，

Saurav

Answer 2

我只能建議是非常，非常小心，很容易的報道。當然，你可以使用諸如SONAR，Eclipse Settings之類的工具來執行註釋。

Buuuuuuuut：

1. 您可以輕鬆地生成註釋（/ W的Eclipse）和 - 作爲你可能 的專有技術生成評價不使用/有益的。
2. 如果你添加一個有用的評論，並且它太依賴於實際的實現，你還必須維護它。每當代碼更改時，您都需要驗證註釋是否也是如此。這經常被忽視，並且由於沒有任何評論而造成更多混亂。儘管你首先有良好的打算。
3. 「真相在於代碼」（tm）：通過非常努力地工作，您可以實現良好的理解和易於維護的代碼。這可能有助於避免需要任何評論。這不容易（並不總是可能的），我承認這一點。
4. 至少必須記錄「公共API」。這可能是一個經驗法則，它似乎可以在大型代碼庫中管理。

我寧願花更多的時間去理解代碼，而不是「強制評論」。您可以通過執行完全相反。

使用Sonar/Eclipse設置強制執行公共API文檔對我來說很有意義。

Answer 3

這需要在源控制級而不是IDE級執行。

如果你使用Git，你可以看看git的鉤http://git-scm.com/docs/githooks

這將讓你寫，當你提交代碼將運行的小腳本。您可以編寫腳本來檢查提交是否包含有效的評論。你也可以允許跳過帶有「-force」選項或類似內容的評論。