如何在 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 似乎符合您的需要。