如何在 Junit 5 中写描述？

Question

我正在使用测试驱动开发方法来编码和测试各种模块。

我想做的事？ :我想为我所有的测试用例写一些描述，这样任何人都可以轻松阅读。

我现在如何写描述？

@Test
@DisplayName("Description about my test case.")
public void addTwoObjects_onInvalidMapping_shouldReturnAnError(){
  .
  . 
  .
}

我怎么不想写描述？ : 我不想用注释来写代码描述。

另外，我不想使用我目前在 JUNIT5 中使用的DisplayName()注释。 因为据我了解，此注释用于重命名技术 function 名称，而不是用于编写描述。
参考：

测试类和测试方法可以通过 @DisplayName 声明自定义显示名称——带有空格、特殊字符，甚至是表情符号——这些名称将显示在测试报告中以及由测试运行程序和 IDE [ 2 ]

这个问题类似于JUnit 测试描述，但有两个区别：（a）询问当前一代的 JUnit 5，和（b）明确要求放置冗长描述的位置，而不是简单地重命名测试方法的名称。

Answer 1

您对DisplayName注释是正确的。 其目的是提供一个比方法名称更易读的名称。 该名称旨在通过提供用户界面以监视测试运行的工具来获取。 该注释不适用于冗长的描述和注释。

Javadoc

Java 中的Javadoc工具使您能够在源代码中附加冗长的描述和注释。 Java 包括用于提取 Javadoc 内容的工具，以将其呈现为用自动生成的 HTML 编写的格式良好的页面。

您的 JUnit 测试是 Java 源代码。 所以你的测试源代码可以携带Javadoc，就像你的应用程序源代码可以携带Javadoc一样。

您的IDE可能具有帮助编写 Javadoc 的功能。

你写了：

以防万一公司里有新的实习生来。 他会了解代码在做什么，即使非技术人员也会从描述中得到一些理解。

事实上，这正是 Javadoc 的用途。 嵌入源中意味着您不会丢失描述和注释的内容。

您的测试源代码上的 Javadoc 似乎符合您的需要。