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

Question

我参与了一个项目，其中公共API文档是一个明确的可交付成果。为了确保发布符合此要求，我想确保如果文档覆盖率太低，我的Ant构建文件中的发布目标将失败。

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

我目前使用Cobertura拥有JUnit代码覆盖率报告和失败条件，因此类似于文档的内容将是完美的。但是，如果无法检测到故障情况，则报告可以合理替代。

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

Answer 1

Checkstyle可以做到这一点。

Answer 2

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