[JAVA] Paramètres CheckStyle

introduction

J'ai eu l'occasion de revoir le fichier de paramètres CheckStyle dans mon travail, et jusqu'à présent, j'ai utilisé le fichier de paramètres créé par mes seniors sans penser à rien, j'ai donc revérifié les paramètres, donc je vais le lister comme mémorandum.

Liste des paramètres

Nom La description
Checker Balise racine du fichier de configuration
TreeWalker Balises qui sont le parent de divers paramètres
JavadocType Avertir si les déclarations de classe et d'interface ne contiennent pas de commentaires Javadoc
JavadocVariable Avertir lorsque les variables membres ne contiennent pas de commentaires Javadoc
JavadocMethod Avertir si la déclaration de méthode ne contient pas de commentaires Javadoc
Indentation Vérifiez le retrait. Avertir si la valeur (nombre d'espaces) définie dans baseOffset ne correspond pas
LineLength Vérifiez le nombre de caractères décrits sur une ligne. Avertir si la valeur définie dans max est dépassée
PackageName Avertir si le nom du package ne correspond pas à l'expression canonique définie dans le format
TypeName class,interface,enum,Avertir si le nom de l'annotation ne correspond pas à l'expression canonique définie dans le format. La cible de jugement peut être définie en jetons (utilisée lorsque vous souhaitez appliquer une autre règle de dénomination uniquement à la classe)
AbstractClassName Avertir si le nom de la classe abstraite ne correspond pas à l'expression canonique définie dans format
MethodName Avertir si le nom de la méthode ne correspond pas à l'expression canonique définie dans le format
ConstantName Avertir si le nom de la constante ne correspond pas à l'expression régulière définie dans le format
MemberName Avertir si le nom d'une variable membre ne correspond pas à l'expression canonique définie dans le format
LocalVariableName Avertir si le nom de la variable locale ne correspond pas à l'expression canonique définie dans format
CatchParameterName try-Avertir lorsque le nom de variable de l'exception interceptée par catch ne correspond pas à l'expression régulière définie au format
LocalFinalVariableName Avertir si le nom d'une constante locale ne correspond pas à l'expression canonique définie dans format
ParameterName Avertir si le nom de l'argument ne correspond pas à l'expression régulière définie dans le format
StaticVariableName Avertir si le nom d'une variable statique ne correspond pas à l'expression canonique définie dans format
MethodLength Avertir lorsque le nombre de lignes dans une méthode (également constructeur) dépasse la valeur définie dans max
AvoidStarImport 「*Avertir lors de l'importation en utilisant
RenduntImport Avertir s'il y a une importation redondante. L'importation redondante est la suivante.
-Lorsqu'il y a plusieurs importations de la même classe
・ Java.Si vous importez une classe qui appartient au package lang
-Si vous importez une classe qui appartient au même package que la classe cible
UnusedImport Avertir s'il y a une importation de classes inutilisées
EmptyBlock 「{}Avertir lorsque l'intérieur de "" est vide.
EmptyCatchBlock Avertir lorsque le traitement de la clause catch est vide
LeftCurly 「{Vérifiez la position où
NeedBraces Dans l'instruction if, for, etc.{}Avertir si le processus n'est pas inclus dans
RightCurly 「}Vérifiez la position où
EmptyStatement Avertir lorsqu'il y a des déclarations non traitées
EqualAvoidNull Dans le type StringNom de variable.equals("aaa")Avertir quand il y a un endroit comme
EqualsHashCode equals()Ou hashCode()Avertir si un seul des est implémenté
HiddenField Avertir lorsque les variables locales, les champs dont les arguments sont définis dans la classe et les noms de variables se chevauchent
IllegalCatch Avertissement si le type d'exception dans la clause chatch utilise le type défini dans illegalClassNames
MagicNumber Avertissez si vous utilisez un nombre magique. Vous pouvez l'exclure de l'avertissement en définissant ignoreNumbers sur un nombre.
MissingSwitchDefault switch-Avertir lorsque la valeur par défaut n'est pas décrite dans l'instruction case
SimplifyBooleanExpression if (variable == true)Avertir lorsqu'il y a une description comme
SimplifyBooleanReturn if (valid) { return true; } else { return false; }Avertir lorsqu'il y a une description comme
HideUtilityClassConstructor Avertir si un constructeur public existe dans une classe utilitaire (une classe avec uniquement des membres statiques)
InterfaceType Avertir lorsqu'il n'y a pas de méthode et qu'il existe une interface à variable uniquement
ArrayTypeStyle Avertir lorsque la méthode de description de la déclaration de tableau n'est pas de style Java (style C)
FinalParameter Pour les arguments de constructeur et de méthodefinalAvertir si n'est pas attaché
ToDoComment Avertir si un commentaire TODO existe
UpperEll Ajouter à la fin d'un nombre dans une longue déclarationLAvertir si est inférieur
TallThrough switch-Avertir si une pause est manquante dans la déclaration de cas
DeclaretionOrder Vérifiez l'ordre de déclaration dans la classe.
La valeur par défaut est variable statique, variable d'instance, constructeur, méthode à partir du haut.
FileTabCharacter Avertir lors de l'utilisation d'onglets dans un fichier
CyclomaticComplexity Avertir lorsque le nombre de chromatiques talentueuses dépasse la valeur définie par max
NPathComplexity Avertir lorsque le nombre de branches conditionnelles dépasse la valeur définie par max
FileLength Avertir si le nombre de lignes dans le fichier entier dépasse la valeur définie pour max
WhitespaceAfter ,,;,if,else,while,do,for,do-whileAvertir s'il n'y a pas d'espace après
WhitespaceAround Une version puissante de Whitespace After.
Mais,,,;Ne peut pas être détecté.
()Vérifiez l'espace avant et après.
NoWhitespaceBefore ,,;,++,--,...Avertir s'il y a un espace devant
NoWhitespaceAfter @,++,--,+,-,!,.,Avertir s'il y a un espace après l'initialisation du tableau
OverloadMethodsDeclarationOrder Avertir lorsque les méthodes surchargées ne sont pas écrites ensemble au même endroit
UnnecessarySemicolonEnumeration Avertir quand un point-virgule inutile est décrit dans enum
MultipleStringLiterals Avertir si le même littéral String se trouve dans le fichier
OuterTypeFilename Avertir lorsque le nom de fichier et le nom de classe défini sont différents
ModifierOrder Avertir si l'ordre des modificateurs ne respecte pas les normes Java.
La commande vient du hautpublic,protected,private,abstract,default,static,final,transient,volatile,synchronaized,native,strictfp
RendundantModifier Avertir s'il existe des modificateurs redondants
ClassTypeParameterName Au moment de la déclaration des génériques de classe<>Vérifiez le nom du type inclus dans

Résumé

Pour le moment, c'est tout pour aujourd'hui. Les paramètres susceptibles d'être utiles en un coup d'œil sont sélectionnés et décrits.

Les paramètres listés dans le tableau ne sont pas tous, mais je les augmenterai progressivement quand j'aurai le temps dans le futur.

Recommended Posts

Paramètres CheckStyle
Prise en charge de CheckStyle