Ich hatte die Möglichkeit, die CheckStyle-Einstellungsdatei in meiner Arbeit zu überprüfen, und bis jetzt habe ich die von meinen Senioren erstellte Einstellungsdatei verwendet, ohne an irgendetwas zu denken. Deshalb habe ich die Parameter erneut überprüft und werde sie als Memorandum auflisten.
| Name | Erläuterung |
|---|---|
| Checker | Root-Tag der Konfigurationsdatei |
| TreeWalker | Tags, die Eltern verschiedener Parameter sind |
| JavadocType | Warnen, wenn Klassen- und Schnittstellendeklarationen keine Javadoc-Kommentare enthalten |
| JavadocVariable | Warnen, wenn Mitgliedsvariablen keine Javadoc-Kommentare enthalten |
| JavadocMethod | Warnen, wenn die Methodendeklaration keine Javadoc-Kommentare enthält |
| Indentation | Überprüfen Sie den Einzug. Warnen, wenn der in baseOffset festgelegte Wert (Anzahl der Leerzeichen) nicht übereinstimmt |
| LineLength | Überprüfen Sie die Anzahl der in einer Zeile beschriebenen Zeichen. Warnen, wenn der in max eingestellte Wert überschritten wird |
| PackageName | Warnen, wenn der Paketname nicht mit dem im Format festgelegten kanonischen Ausdruck übereinstimmt |
| TypeName | class,interface,enum,Warnen, wenn der Anmerkungsname nicht mit dem im Format festgelegten kanonischen Ausdruck übereinstimmt. Das Beurteilungsziel kann in Token festgelegt werden (wird verwendet, wenn Sie eine andere Namensregel nur auf die Klasse anwenden möchten). |
| AbstractClassName | Warnen, wenn der Name der abstrakten Klasse nicht mit dem im Format festgelegten kanonischen Ausdruck übereinstimmt |
| MethodName | Warnen, wenn der Methodenname nicht mit dem im Format festgelegten kanonischen Ausdruck übereinstimmt |
| ConstantName | Warnen, wenn der Name der Konstante nicht mit dem im Format festgelegten regulären Ausdruck übereinstimmt |
| MemberName | Warnen, wenn der Name einer Mitgliedsvariablen nicht mit dem im Format festgelegten kanonischen Ausdruck übereinstimmt |
| LocalVariableName | Warnen, wenn der Name der lokalen Variablen nicht mit dem im Format festgelegten kanonischen Ausdruck übereinstimmt |
| CatchParameterName | try-Warnen, wenn der Variablenname der von catch abgefangenen Ausnahme nicht mit dem im Format festgelegten regulären Ausdruck übereinstimmt |
| LocalFinalVariableName | Warnen, wenn der Name einer lokalen Konstante nicht mit dem im Format festgelegten kanonischen Ausdruck übereinstimmt |
| ParameterName | Warnen, wenn der Name des Arguments nicht mit dem im Format festgelegten regulären Ausdruck übereinstimmt |
| StaticVariableName | Warnen, wenn der Name einer statischen Variablen nicht mit dem im Format festgelegten kanonischen Ausdruck übereinstimmt |
| MethodLength | Warnen, wenn die Anzahl der Zeilen in einer Methode (auch Konstruktor) den in max |
| AvoidStarImport | 「*Beim Importieren mit warnen |
| RenduntImport | Warnen, wenn ein redundanter Import vorliegt. Der redundante Import ist wie folgt. -Wenn es mehrere Importe derselben Klasse gibt ・ Java.Wenn Sie eine Klasse importieren, die zum lang-Paket gehört -Wenn Sie eine Klasse importieren, die zum selben Paket wie die Zielklasse gehört |
| UnusedImport | Warnen, wenn nicht verwendete Klassen importiert werden |
| EmptyBlock | 「{}Warnen, wenn das Innere von "" leer ist. |
| EmptyCatchBlock | Warnen, wenn die Verarbeitung der catch-Klausel leer ist |
| LeftCurly | 「{Überprüfen Sie die Position wo |
| NeedBraces | In der if-Anweisung, für Anweisung usw.{}Warnen, wenn der Prozess nicht eingeschlossen ist |
| RightCurly | 「}Überprüfen Sie die Position wo |
| EmptyStatement | Warnen, wenn unverarbeitete Anweisungen vorliegen |
| EqualAvoidNull | In String-TypVariablennamen.equals("aaa")Warnen, wenn es einen Ort wie gibt |
| EqualsHashCode | equals()Oder hashCode()Warnen, wenn nur einer von ihnen implementiert ist |
| HiddenField | Warnen, wenn sich lokale Variablen, Felder, deren Argumente in den Klassen- und Variablennamen definiert sind, überlappen |
| IllegalCatch | Warnen, wenn der Ausnahmetyp in der Chatch-Klausel den in illegalClassNames festgelegten Typ verwendet |
| MagicNumber | Warnen Sie, wenn Sie eine magische Zahl verwenden. Sie können es von der Warnung ausschließen, indem Sie ignoreNumbers auf eine Zahl setzen. |
| MissingSwitchDefault | switch-Warnen, wenn die Standardeinstellung in der case-Anweisung nicht beschrieben ist |
| SimplifyBooleanExpression | if (variable == true)Warnen, wenn es eine Beschreibung wie gibt |
| SimplifyBooleanReturn | if (valid) { return true; } else { return false; }Warnen, wenn es eine Beschreibung wie gibt |
| HideUtilityClassConstructor | Warnen, wenn ein öffentlicher Konstruktor in einer Utility-Klasse vorhanden ist (eine Klasse mit nur statischen Elementen) |
| InterfaceType | Warnen, wenn keine Methode vorhanden ist und eine Schnittstelle nur für Variablen vorhanden ist |
| ArrayTypeStyle | Warnen, wenn die Beschreibungsmethode der Array-Deklaration nicht Java-Stil (C-Stil) ist |
| FinalParameter | Für Konstruktor- und MethodenargumentefinalWarnen, wenn nicht angebracht |
| ToDoComment | Warnen, wenn ein TODO-Kommentar vorhanden ist |
| UpperEll | Fügen Sie am Ende einer Zahl eine lange Erklärung hinzuLWarnen, wenn niedriger ist |
| TallThrough | switch-Warnen, wenn in der case-Anweisung eine Unterbrechung fehlt |
| DeclaretionOrder | Überprüfen Sie die Reihenfolge der Deklaration in der Klasse. Der Standardwert ist statische Variable, Instanzvariable, Konstruktor und Methode von oben. |
| FileTabCharacter | Warnung bei Verwendung von Registerkarten in einer Datei |
| CyclomaticComplexity | Warnen, wenn die Anzahl der talentierten Chromatiker den durch max |
| NPathComplexity | Warnen, wenn die Anzahl der bedingten Verzweigungen den durch max |
| FileLength | Warnen, wenn die Anzahl der Zeilen in der gesamten Datei den für max |
| WhitespaceAfter | ,,;,if,else,while,do,for,do-whileWarnen, wenn danach kein Platz mehr vorhanden ist |
| WhitespaceAround | Eine leistungsstarke Version von Whitespace After. Aber, ,,;Kann nicht erkannt werden.()Überprüfen Sie den Platz vorher und nachher. |
| NoWhitespaceBefore | ,,;,++,--,...Warnen Sie, wenn sich vor Ihnen ein Leerzeichen befindet |
| NoWhitespaceAfter | @,++,--,+,-,!,.,Warnen, wenn nach der Array-Initialisierung ein Leerzeichen vorhanden ist |
| OverloadMethodsDeclarationOrder | Warnen, wenn überladene Methoden nicht an einer Stelle zusammen geschrieben werden |
| UnnecessarySemicolonEnumeration | Warnen, wenn ein unnötiges Semikolon in enum beschrieben wird |
| MultipleStringLiterals | Warnen, wenn sich dasselbe String-Literal in der Datei befindet |
| OuterTypeFilename | Warnen, wenn der Dateiname und der definierte Klassenname unterschiedlich sind |
| ModifierOrder | Warnen, wenn die Reihenfolge der Modifikatoren nicht den Java-Standards entspricht. Die Bestellung erfolgt von oben public,protected,private,abstract,default,static,final,transient,volatile,synchronaized,native,strictfp |
| RendundantModifier | Warnen, wenn redundante Modifikatoren vorhanden sind |
| ClassTypeParameterName | Zum Zeitpunkt der Deklaration von Klassengenerika<>Überprüfen Sie den beiliegenden Typnamen |
Das ist vorerst alles für heute. Die auf einen Blick nützlichen Parameter werden ausgewählt und beschrieben.
Die in der Tabelle aufgeführten Parameter sind nicht alle, aber ich werde sie schrittweise erhöhen, wenn ich in Zukunft Zeit habe.