我参与了一个项目，其中公共 API 文档是一个明确的可交付成果。为了确保发布满足这个要求，如果文档覆盖率太低，我想确保我的 Ant 构建文件中的发布目标失败。
至少，每个具有公共或受保护访问权限的标识符都应具有适当的 Javadoc 标记和描述。例如，公共方法@param的每个参数都应该有一个标签，@return如果返回类型不是void，则应该有一个标签@throws，每个异常都有一个标签，以及单行描述。
我目前有使用 Cobertura 的 JUnit 代码覆盖率报告和故障条件，因此类似于文档的内容将是完美的。但是，如果无法检测到故障情况，则报告是合理的替代品。
文档必须采用 Javadoc 格式。没有其他格式（包括 Doxygen）是可接受的。