Comment désactiver une règle de checkstyle particulière pour une ligne de code particulière?

si vous préférez utiliser des annotations pour réduire sélectivement au silence les règles, cela est maintenant possible en utilisant l'annotation @SuppressWarnings , en commençant par Checkstyle 5.7 (et supporté par le Plugin Checkstyle Maven 2.12+).

tout D'abord, dans votre checkstyle.xml , ajouter le" module 151960920 "au TreeWalker :

<module name="TreeWalker">
    <!-- Make the @SuppressWarnings annotations available to Checkstyle -->
    <module name="SuppressWarningsHolder" />
</module>

ensuite, activez le SuppressWarningsFilter là (comme un frère à TreeWalker ):

<!-- Filter out Checkstyle warnings that have been suppressed with the @SuppressWarnings annotation -->
<module name="SuppressWarningsFilter" />

<module name="TreeWalker">
...

Maintenant vous pouvez annoter par exemple la méthode que vous voulez exclure d'une certaine règle de Checkstyle:

@SuppressWarnings("checkstyle:methodlength")
@Override
public boolean equals(Object obj) {
    // very long auto-generated equals() method
}

le préfixe checkstyle: dans l'argument de @SuppressWarnings est facultatif, mais je l'aime comme un rappel d'où cet avertissement vient. Le nom de la règle doit être en minuscules.

enfin, si vous utilisez Eclipse, il se plaindra que l'argument lui est inconnu:

non supporté @SuppressWarnings ("checkstyle:methodlength")

vous pouvez désactiver cet avertissement D'éclipse dans les préférences si vous aimez:

Preferences:
  Java
  --> Compiler
  --> Errors/Warnings
  --> Annotations
  --> Unhandled token in '@SuppressWarnings': set to 'Ignore'

ce qui fonctionne aussi bien est le SuppressWithNearbyCommentFilter qui utilise les commentaires individuels pour supprimer les événements de vérification.

par exemple

// CHECKSTYLE IGNORE check FOR NEXT 1 LINES
public void onClick(View view) { ... }

pour configurer un filtre de sorte que CHECKSTYLE IGNORE check FOR NEXT var LINES évite de déclencher des audits pour le contrôle donné pour la ligne courante et les prochaines lignes var (pour un total de var+1 lines):

<module name="SuppressWithNearbyCommentFilter">
    <property name="commentFormat" value="CHECKSTYLE IGNORE (\w+) FOR NEXT (\d+) LINES"/>
    <property name="checkFormat" value=""/>
    <property name="influenceFormat" value=""/>
</module>

http://checkstyle.sourceforge.net/config.html

chaque réponse faisant référence à SuppressWarningsFilter manque un détail important. Vous ne pouvez utiliser l'id all-lowercase que s'il est défini comme tel dans votre checkstyle-config.XML. Si ce n'est pas le cas, vous devez utiliser le nom du module original.

par exemple, si dans mon checkstyle-config.xml que j'ai:

<module name="NoWhitespaceBefore"/>

Je ne peux pas utiliser:

@SuppressWarnings({"nowhitespacebefore"})

toutefois, je dois utiliser:

@SuppressWarnings({"NoWhitespaceBefore"})

pour la première syntaxe fonctionne, le checkstyle-config.xml devrait avoir:

<module name="NoWhitespaceBefore">
  <property name="id" value="nowhitespacebefore"/>
</module>

C'est ce qui a fonctionné pour moi, au moins dans la version de CheckStyle 6.17.

j'ai eu de la difficulté avec les réponses ci-dessus, peut-être parce que j'ai placé les avertissements de style de vérification pour être des erreurs. Ce qui a fonctionné était SuppressionFilter: http://checkstyle.sourceforge.net/config_filters.html#SuppressionFilter

L'inconvénient de ceci est que la ligne est stocké dans un autre suppresssions.fichier xml, de sorte qu'un inconnu développeur ne peut pas immédiatement la connexion.

<module name="Checker">
    <module name="SuppressionCommentFilter"/>
    <module name="TreeWalker">
        <module name="FileContentsHolder"/>
    </module>
</module>

pour configurer un filtre pour supprimer les événements d'audit entre un commentaire contenant le code BEGIN GENERATED de la ligne et un commentaire contenant le CODE END GENERATED de la ligne:

<module name="SuppressionCommentFilter">
  <property name="offCommentFormat" value="BEGIN GENERATED CODE"/>
  <property name="onCommentFormat" value="END GENERATED CODE"/>
</module>

//BEGIN GENERATED CODE
@Override
public boolean equals(Object obj) { ... } // No violation events will be reported

@Override
public int hashCode() { ... } // No violation events will be reported
//END GENERATED CODE

voir plus