checkstyle

Checkstyle - Alat Kualitas Kode Java

Versi rilis terbaru dapat ditemukan di rilis GitHub atau di repo Maven.

Setiap pembuatan artefak maven dapat ditemukan di repositori Maven Snapshot.

Dokumentasi tersedia dalam format HTML, lihat https://checkstyle.org/checks.html .

Daftar isi

• Mulai Cepat
• Berkontribusi
• Umpan Balik dan Dukungan
• Javadoc
• Gaya Periksa Sponsor
• Perizinan

Mulai Cepat

• Unduh Rilis Terbaru kami dari GitHub atau Tambahkan Checkstyle ke build Anda dari Maven Central.
• Baca Dokumentasi kami untuk penggunaan dan konfigurasi.

$ 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.

Berkontribusi

Terima kasih atas minat Anda berkontribusi pada CheckStyle! Silakan lihat Pedoman Kontribusi untuk informasi tentang cara berkontribusi pada proyek. Ini termasuk membuat masalah, mengirimkan permintaan penarikan, dan menyiapkan lingkungan pengembangan Anda.

Petunjuk Pembuatan

Silakan lihat Dokumentasi CheckStyle untuk informasi tentang cara membangun proyek.

Umpan Balik dan Dukungan

• Kunjungi Halaman Diskusi kami, tempat Anda dapat mengajukan pertanyaan dan mendiskusikan proyek dengan pengguna dan kontributor lain. Ini adalah metode komunikasi pilihan kami untuk topik seperti pertanyaan penggunaan dan konfigurasi, proses debug, dan masukan lainnya.
• Stack Overflow adalah tempat lain untuk mengajukan pertanyaan tentang penggunaan Checkstyle.
• Jika Anda tertarik untuk berkontribusi pada proyek ini, Anda dapat bergabung dengan Obrolan Kontributor Discord kami.
• Forum Grup Google kami adalah milis untuk diskusi dan dukungan; namun, kami mungkin lambat meresponsnya.

Javadoc

Lihatlah javadoc kami untuk melihat dokumentasi API kami.

Gaya Periksa Sponsor

Checkstyle adalah proyek sumber terbuka yang dikembangkan dan dikelola oleh sukarelawan. Jika Anda merasa Checkstyle berguna, harap pertimbangkan untuk mensponsori proyek tersebut. Dukungan Anda membantu kami mempertahankan dan meningkatkan Checkstyle.

• Liberapay
• Kolektif Terbuka

Perizinan

Checkstyle dilisensikan di bawah Lisensi GNU LGPL v2.1. Checkstyle menggunakan perpustakaan:

• ANTLR
• Apache Umum
• Google Jambu Biji
• picokli