title: How to write description in Junit?
body: <p>I am using <a href="https://en.wikipedia.org/wiki/Test-driven_development" rel="nofollow noreferrer">Test Driven Development</a> approach for coding and testing various modules.</p>
  <hr />
  <p><strong>What I want to do? :</strong>
  I want to write some description to all my test cases so it could easily be readable for anyone.</p>
  <p><strong>How I am writing description right now?</strong></p>
  <pre><code>@Test
  @DisplayName(&quot;Description about my test case.&quot;)
  public void addTwoObjects_onInvalidMapping_shouldReturnAnError(){
    .
    . 
    .
  }
  </code></pre>
  <p><strong>How I don't want to write description?</strong>: I don't want to use comments to write  description of code.</p>
  <hr />
  <p><br/><strong>Also, I don't want to use the <code>DisplayName()</code> annotation</strong> which I am currently using in JUNIT5. As this annotation by my understanding is meant for renaming technical function names and not for writing description.
  <br/>Reference:</p>
  <blockquote>
  <p>Test classes and test methods can declare custom display names via @DisplayName — with spaces, special characters, and even emojis — that will be displayed in test reports and by test runners and IDEs [<a href="https://junit.org/junit5/docs/current/user-guide/#writing-tests-display-names" rel="nofollow noreferrer">2</a>]</p>
  </blockquote>
  <hr />
  <p>This Question is similar to <a href="https://stackoverflow.com/q/13159293/642706"><em>JUnit test description</em></a>, but for two differences: (a) Asking about the current generation of JUnit 5, and (b) Explicitly asking for place to put a lengthy description rather than simply renaming the test method’s name.</p>