Javadoc dans Junit test de classes?

Est une bonne pratique à mettre des commentaires Javadoc dans junit test de classes et de méthodes? Ou est l'idée qu'ils doivent être vraiment facile à lire et simple qu'il est inutile de fournir une description de l'essai l'intention?

  • Que pensez-vous de la place en utilisant un non-Javadoc bloquer les commentaires? Quoi de mieux pour le style de code?
InformationsquelleAutor HDave | 2010-06-03
  1. 21

    Personnellement j'utilise les commentaires javadoc avec parcimonie, car je trouve qu'elles augmentent l'encombrement à l'écran. Si je peux nommer une classe, une fonction ou une variable dans un plus auto-descriptif, alors je vais dans préférence à un commentaire. Un excellent livre à lire sur ce sujet est Code Propre par Robert C. Martin (un.k.un Oncle Bob).

    Ma préférence personnelle est de faire à la fois la classe et les méthodes d'auto-descriptif, c'est à dire

    class ANewEventManager {
   @Test
   public void shouldAllowClassesToSubscribeToEvents() {
        /* Test logic here */
   }
}

    Un avantage de cette approche est qu'il est facile de voir dans la junit sortie de ce qui est défectueux avant de parcourir le code.

    • La lecture de code propre droit maintenant. Juste de finir les Tests Unitaires par Roy Ohserov qui a vraiment insisté sur la lisibilité, de tests unitaires et d'intégration.
    InformationsquelleAutor Martin
  2. 37

    Je utiliser la Javadoc dans mes tests beaucoup.
    Mais il ne devient vraiment utile lorsque vous ajoutez votre propre tag à votre javadoc.

    L'objectif principal ici est de faire le test compréhensible pour les autres développeurs de contribuer à votre projet. Et pour cela nous n'avons même pas besoin de générer une réelle javadoc.

    /**
 * Create a valid account.
 * @result Account will be persisted without any errors,
 *         and Account.getId() will no longer be <code>null</code>
 */
@Test
public void createValidAccount() {
    accountService.create(account);
    assertNotNull(account.getId());
}

    Prochaine, nous allons avoir besoin de vous informer de nos Javadoc plugin maven que nous avons ajouté une nouvelle balise.

    <build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>2.8</version>
            <configuration>
                <tags>
                    <tag>
                        <name>result</name>
                        <placement>a</placement>
                        <head>Test assertion :</head>
                    </tag>
                </tags>
            </configuration>             
        </plugin>    
    </plugins>        
</build>

    Et maintenant tout ce qui reste à faire est d'appeler notre plugin maven.

    javadoc:test-javadoc (or javadoc:test-aggregate for multi-module projects)

    C'est assez facile, par exemple, mais lors de l'exécution de plus de tests complexes, il est impossible de décrire les tests en utilisant simplement une auto-descriptive nom de la méthode.

    • Quelle serait la sortie de votre exemple?
    InformationsquelleAutor Foumpie
  3. 0

    J'aime aussi les commentaires en UT, elle aide à comprendre les cas d'utilisation en quelques secondes.

    J'ai créé une petite bibliothèque à inclure des descriptions dans le stacktrace de tout type de rapport, quelqu'un qui est en train de vérifier les rapports peuvent obtenir facilement le problème.

    Le nom de la bibliothèque est Frutilla, n'hésitez pas à l'utiliser
    https://github.com/ignaciotcrespo/frutilla

    InformationsquelleAutor Ignacio Tomas Crespo