JUnit 测试应该被 javadocced 吗?

2022-09-03 00:04:18

我有许多JUnit测试用例,这些用例目前没有用Javadoc注释记录。

我的代码的其余部分是文档的,但我想知道是否值得努力记录这些测试。


答案 1

如果测试的目的很明显,我就懒得记录它了。

如果它不明显,因为它处理一些晦涩难懂的情况 - 或者如果我想引用一个特定的错误,例如 - 在这种情况下我会添加文档。我不记录异常抛出等 - 只是方法的快速摘要。这种情况发生得相对较少。我更有可能为多个测试中使用的帮助程序方法添加文档。


答案 2

我发现javadocing测试用例没有任何价值。我只是使方法名称具有足够的描述性,以便知道测试的目的。

在Ruby中,我知道有一些工具可以从测试的名称创建文档,但我还没有在Java中看到过其中一个。


推荐