[Dúvida] @DisplayName

Olá Marcus!

Entendo sua preocupação sobre a adição de mais uma linha com a anotação @DisplayName em cada método de teste. Realmente, pode parecer à primeira vista que isso apenas aumenta a quantidade de texto a ser escrita. No entanto, essa anotação traz benefícios significativos em termos de legibilidade e clareza dos testes, especialmente em cenários complexos.

A vantagem principal do uso de @DisplayName é permitir que você descreva o propósito do teste de uma maneira mais legível e acessível, sem as restrições de nomenclatura de métodos em Java, como você mesmo observou nos exemplos da aula. Isso significa que você pode usar espaços, caracteres especiais e até emojis, tornando os nomes dos testes mais intuitivos e fáceis de entender em relatórios de teste.

Por exemplo, ao invés de ter um método de teste com um nome extremamente longo como probabilidadeDeveriaSerAltaParaGatosJovensComPesoBaixo, que pode ser difícil de ler e entender rapidamente, você pode simplificar o nome do método para algo como probabilidadeAltaCenario1 e usar um @DisplayName mais descritivo e legível, como "Probabilidade alta para gatos jovens com peso baixo". Isso não só melhora a legibilidade do código, mas também torna os relatórios de teste mais compreensíveis para outros desenvolvedores ou partes interessadas que possam estar revisando os resultados dos testes.

Além disso, ao separar o nome técnico do método (que pode seguir uma nomenclatura mais simples e consistente) do nome descritivo do teste, você facilita tanto a manutenção do código quanto a identificação rápida dos cenários de teste por qualquer pessoa que esteja lendo ou revisando seu código de testes.

Espero ter ajudado e bons estudos!