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

Question

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

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

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

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

Answer 1

Checkstyle可以做到这一点。