我应该评论我的测试吗？

Question

我即将编写另一个涵盖新功能的Java测试。为了记录这个新测试的原因，我正在考虑通过对该功能的解释来评论测试。

我应该这样做吗？

将测试与功能链接起来的好方法是什么？

Answer 1

您应该以这样一种方式命名您的测试，以便明显测试哪个功能以及该测试的条件。

如果出于某种原因，这是不可能的，那么只有这样才能为您的测试添加最少的评论;就像你写的任何代码一样。

Answer 2

通常我们所做的是提供描述性测试名称，以便在测试失败时我们可以确定哪个功能失败，而无需查看测试代码。

例如：divideWithZeroShouldFailAndThrowAnException()是一个完美的测试方法名称，如果您计划测试Calculator类的divide方法。

Answer 3

首先，您的测试代码应该是不言自明的。除了GaryF的回答之外，我建议使用断言方法，它会在不太清楚的情况下用一条消息来描述一个错误的原因。例如，assertEquals(java.lang.String, java.lang.Object, java.lang.Object)

即使您查看测试结果，它也可以帮助您了解究竟是什么，但不是在测试代码中。