Должен ли я прокомментировать мои тесты?

Question

Я собираюсь написать еще один Java-тест, который охватывает новую функцию.Чтобы задокументировать причину этого нового теста, я думаю о том, чтобы прокомментировать тест с объяснением этой функции.

Должен ли я сделать это?

Как правильно связать тесты с функциями?

Answer 1

Вы должны называть свои тесты таким образом, чтобы было очевидно, какая функция тестируется, и условия этого теста.

Если по какой-либо причине это невозможно, тогда и только тогда следуетВы добавляете минимальный комментарий к своему тесту;как и должно быть для ЛЮБОГО кода, который вы пишете.

Answer 2

Прежде всего, код вашего теста должен быть понятен. В дополнение к ответу GaryF, я предлагаю использовать методы assert, которые принимают сообщение, описывающее причину того, что не так в случаях, когда это не так ясно. Например, assertEquals (java.lang.String, java.lang.Object, java.lang.Object)

Это поможет вам понять, что именно было сломано, даже если вы посмотрите на результаты теста, а не в коде теста.

Answer 3

Обычно мы создаем описательные имена тестов, чтобы в случае неудачи теста мы могли определить, какая функция не пройдена, не просматривая код теста.

Например: divideWithZeroShouldFailAndThrowAnException() - это идеальное имя метода тестирования, если вы планируете тестировать метод Calculator класса *1004*.