爲java項目生成javadoc

Question

最近我們計劃在我們的項目中使用checkstyle插件。作爲此練習的一部分，必須清理現有代碼以符合checkstyle規則。我們發現接近18K的違規行爲與課堂文件中缺少javadoc註釋相對應。

我的問題是，有什麼插件或工具，我可以用它來生成整個工件的javadoc評論？ 我看過JAutodoc，我想 想知道是否有比這更好的東西。

Answer 1

即使CheckStyle得分上升，通過生成JavaDoc，您的真實代碼質量也會下降。生成的JavaDoc只能反映代碼中已經顯而易見的內容，它增加了可減少可讀性的數據量，並且可能（取決於您的工具）不能保持最新狀態，增加維護負擔並導致代碼演變後出現不一致。

不要讓自己陷入混亂的代碼。 CheckStyle違規應該被視爲暗示，而不是絕對的鐵腕規則。添加敏感的JavaDoc需要時間和對代碼的理解，您應該從現在開始在所有新代碼中制定策略，並在重構時將其添加到任何現有代碼中。

順便說一句：你不必JavaDoc的一切。我個人沒有JavDoc默認的getters/setters，覆蓋或方法/字段與自我解釋的名稱（我爭取）。我總是使用JavaDoc頂級實體（接口，類和枚舉），並將非JavaDoc註釋放在一些複雜的代碼塊上。

Answer 2

最近有同樣的問題。我們只是更改了checkstyle配置文件，將缺少的javadoc僅設置爲警告，直到我們的貢獻者包含缺失的文檔。

如何做到這一點在這裏描述link text，或者你可以使用提供GUI界面的eclipse checkstyle插件。

Answer 3

如果您創建NetBeans項目，您可以要求它爲您自動生成缺失的骨架。一個簡單的鼠標右鍵點擊該項目來選擇菜單項，你將擁有所有缺失的骨架。

另一個工具（花錢，但非常值得）是Jalopy from triemax的商業版本，它是一個優秀的代碼格式化程序（開發人員響應速度很快，並且在請求時相對較快地添加了新功能）。