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

我参与了一个项目，在该项目中，公共API文档是一个明确的可交付成果。为了确保发行版满足这一要求，我想确保如果文档覆盖率太低，Ant构建文件中的发行版目标会失败

作为最低要求，每个具有公共或受保护访问权限的标识符都应该具有适当的Javadoc标记和描述。例如，对于每个参数，公共方法应该有一个

@param

标记；如果返回类型不是

void

，则应该有一个

@return

标记；对于每个异常，应该有一个

@throws

标记，以及一行描述

目前，我使用Cobertura编写了JUnit代码覆盖率报告和故障情况报告，因此类似于文档的内容将是完美的。但是，如果无法检测到故障情况，则报告是合理的替代品

---

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

我不知道这样的工具，但我认为Doxygen可以生成描述代码结构和注释的XML文件。

---

您可以编写一个脚本，对其进行一些简单的测试，并查找未记录的方法/参数/返回值等。

可以做到这一点。

文档必须是Javadoc，因此很遗憾，Doxygen不是一个选项。您只能将Doxygen用于覆盖率测量，而Javadoc可以实际生成它。但是starblue有一个更好的选择。尽管如此，你的答案还是有用的，+1。对于“你可以写脚本[…]”部分，有。免责声明：我正在为那个项目做贡献。为什么我没想到呢？非常感谢！