checkstyle

Checkstyle – Java-Code-Qualitätstool

Die neueste Release-Version finden Sie unter GitHub-Releases oder im Maven-Repo.

Jeder-Commit-Builds von Maven-Artefakten finden Sie im Maven Snapshot-Repository.

Die Dokumentation ist im HTML-Format verfügbar, siehe https://checkstyle.org/checks.html.

Inhaltsverzeichnis

• Schnellstart
• Mitwirken
• Feedback und Support
• Javadoc
• Sponsor Checkstyle
• Lizenzierung

Schnellstart

• Laden Sie unsere neueste Version von GitHub herunter oder fügen Sie Checkstyle zu Ihrem Build von Maven Central hinzu.
• Lesen Sie unsere Dokumentation zur Verwendung und Konfiguration.

$ cat config.xml
< ? xml version= " 1.0 " ? >
< ! DOCTYPE module PUBLIC
          " -//Puppy Crawl//DTD Check Configuration 1.3//EN "
          " https://checkstyle.org/dtds/configuration_1_3.dtd " >
< module name= " Checker " >
  < module name= " TreeWalker " >
    < module name= " FallThrough " / >
  < /module >
< /module >

$ cat Test.java
class Test {
  public void foo () {
    int i = 0 ;
    while (i > = 0) {
      switch (i) {
        case 1:
        case 2:
          i++ ;
        case 3: // violation ' fall from previous branch of the switch '
          i++ ;
      }
    }
  }
}

$ java -jar checkstyle-10.18.1-all.jar -c config.xml Test.java
Starting audit...
[ERROR] Test.java:9:9: Fall through from previous branch of switch statement [FallThrough]
Audit done.
Checkstyle ends with 1 errors.

Mitwirken

Vielen Dank für Ihr Interesse, zu CheckStyle beizutragen! Informationen darüber, wie Sie zum Projekt beitragen können, finden Sie in den Beitragsrichtlinien. Dazu gehört das Erstellen von Problemen, das Senden von Pull-Requests und das Einrichten Ihrer Entwicklungsumgebung.

Bauanleitung

Informationen zum Erstellen des Projekts finden Sie in der CheckStyle-Dokumentation.

Feedback und Support

• Besuchen Sie unsere Diskussionsseite, wo Sie Fragen stellen und das Projekt mit anderen Benutzern und Mitwirkenden diskutieren können. Dies ist unsere bevorzugte Kommunikationsmethode für Themen wie Nutzungs- und Konfigurationsfragen, Debugging und anderes Feedback.
• Stack Overflow ist ein weiterer Ort, an dem Sie Fragen zur Verwendung von Checkstyle stellen können.
• Wenn Sie daran interessiert sind, zum Projekt beizutragen, können Sie unserem Discord Contributors Chat beitreten.
• Unser Google Groups-Forum ist eine Mailingliste für Diskussionen und Support. Es kann jedoch sein, dass wir hier nur langsam reagieren.

Javadoc

Werfen Sie einen Blick auf unser Javadoc, um unsere API-Dokumentation zu sehen.

Sponsor Checkstyle

Checkstyle ist ein Open-Source-Projekt, das von Freiwilligen entwickelt und gepflegt wird. Wenn Sie Checkstyle nützlich finden, denken Sie bitte darüber nach, das Projekt zu sponsern. Ihre Unterstützung hilft uns, Checkstyle aufrechtzuerhalten und zu verbessern.

• Liberapay
• OpenCollective

Lizenzierung

Checkstyle ist unter der GNU LGPL v2.1-Lizenz lizenziert. Checkstyle verwendet Bibliotheken:

• ANTLR
• Apache Commons
• Google Guave
• Picocli