使用Javadoc和Ant測量文檔覆蓋率

Question

我參與了公開API文檔明確可交付的項目。爲了確保該版本符合此要求，我想確保如果文檔覆蓋率太低，我的Ant構建文件中的發佈目標失敗。

至少，每個具有公共訪問權限或受保護訪問權限的標識符都應該具有適當的Javadoc標籤和描述。例如，對於每個參數，公共方法應該有一個@param標記，如果返回類型不是void，則爲@return標記，每個異常標記爲@throws，以及單行描述。

我目前有使用Cobertura的JUnit代碼覆蓋率報告和失敗情況，所以類似於文檔的東西將是完美的。但是，如果檢測到失敗情況不可用，報告應該是一個合理的替代品。

文檔必須爲Javadoc格式。沒有其他格式 - 包括Doxygen - 是可以接受的。

Answer 1

Checkstyle可以做到這一點。

Answer 2

我不知道這樣的工具，但我認爲Doxygen可以生成描述代碼結構和註釋的XML文件。 你可以編寫一個腳本來做一些簡單的測試，並找到未記錄的方法/ params /返回值/ etc。