是否有任何工具自動更新Javadoc？

我工作的代碼基礎是...凌亂。這種混亂的一個方面是我們有很多方法的簽名不再與相關的Javadoc相匹配。例如：是否有任何工具自動更新Javadoc？

/** 
* 
* @ param foo 
*/ 
public void doFoo(int bar) {...

我不是生成的Javadoc的風扇（因爲它幾乎總是不值錢的），但我真的可以使用一個工具，通過我們的代碼，發現這樣的情況下，和：

刪除的Javadoc的「富」參數
爲「欄」參數（而只是一個空白的，沒有自動生成文檔或任何東西）

請問這樣的工具存在添加的Javadoc？如果不是，那麼只有＃1存在的工具？即使這麼多，也會大大減少我們在構建中獲得的垃圾警告的數量。謝謝。

來源

2009-12-07 machineghost

P.S.我曾嘗試在SO中搜索這樣的問題（因爲我預計會有一個問題），但涉過幾百個問題後，我仍然沒有提出任何問題，所以...新問題:-) – machineghost 2009-12-07 19:42:08

NetBeans爲此提供了一個工具。它完全符合你的要求。

您可以從頂部，或右鍵單擊文件上Tools菜單，然後Analyze Javadocs並單擊Tools，然後Analyze Javadocs。

然後這給你一個列表，它找到你的Javadocs的所有問題，並帶有修復它的選項。它允許您修復方法中的單個問題，修復方法的javadoc，文件，包或整個項目的javadoc。

來源

2009-12-07 19:59:49

默認情況下（至少在** Netbeans 8.0.2 **中）這個工具**不會在私有方法中發現JavaDoc中的錯誤爲了改變**的範圍分析Javadoc **進入'工具 - >選項 - >編輯 - >提示 - > JavaDoc - >錯誤Javadoc - >範圍'並將範圍更改爲私有。 – 2014-12-09 17:28:02

如果您使用的是eclipse，一個解決方案是去Window -> Preferences -> Java -> Compiler -> Javadoc ，然後將'Malformed Javadoc comments'變量設置爲警告或錯誤。

然後，您可以轉到問題視圖Window -> Show View -> Problems，然後在每個錯誤上右鍵單擊並選擇「快速修復」。

來源

2009-12-07 19:52:53

我試過（儘管我將NetBeans解決方案標記爲答案，因爲它看起來更強大，我個人是Eclipse用戶）。但是，沒有一個警告出現在問題中:-(當我查看其中一個時，它下面有一條黃色的波浪線，但即使我告訴Eclipse驗證該文件，在問題窗口中仍然沒有任何提示。關於我可能會做錯什麼的想法？ – machineghost 2009-12-09 21:01:04

我還沒有嘗試過DocCheck以外的任何其他方法，但this somewhat-dated page on Sun's site列出了幾個第三方doclet，其中一些旨在將Javadoc插入到源代碼中。其中，您可以看看Doc-o-Matic,JRefactory Pretty Printer和ACTOS Auto Commentator for Java。再次，我還沒有嘗試過任何這些，但它是一個開始的地方。

來源

2009-12-07 20:07:55 shoover

是否有任何工具自動更新Javadoc？

回答

相關問題