使用Javadoc和Ant测量文档覆盖率

Question

我参与了公开API文档明确可交付的项目。为了确保该版本符合此要求，我想确保如果文档覆盖率太低，我的Ant构建文件中的发布目标失败。

至少，每个具有公共访问权限或受保护访问权限的标识符都应该具有适当的Javadoc标签和描述。例如，对于每个参数，公共方法应该有一个@param标记，如果返回类型不是void，则为@return标记，每个异常标记为@throws，以及单行描述。

我目前有使用Cobertura的JUnit代码覆盖率报告和失败情况，所以类似于文档的东西将是完美的。但是，如果检测到失败情况不可用，报告应该是一个合理的替代品。

文档必须为Javadoc格式。没有其他格式 - 包括Doxygen - 是可以接受的。

Answer 1

Checkstyle可以做到这一点。

Answer 2

我不知道这样的工具，但我认为Doxygen可以生成描述代码结构和注释的XML文件。 你可以编写一个脚本来做一些简单的测试，并找到未记录的方法/ params /返回值/ etc。