checkstyle

Checkstyle - Java 程式碼品質工具

最新的發行版本可以在 GitHub 版本或 Maven 儲存庫中找到。

Maven 工件的每次提交建置都可以在 Maven 快照儲存庫中找到。

文件以 HTML 格式提供，請參閱 https://checkstyle.org/checks.html 。

目錄

• 快速入門
• 貢獻
• 回饋與支持
• Java文檔
• 贊助方格風格
• 授權

快速入門

• 從 GitHub 下載我們的最新版本或從 Maven Central 將 Checkstyle 新增到您的建置中。
• 請閱讀我們的文件以了解使用和配置。

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

貢獻

感謝您有興趣為 CheckStyle 做出貢獻！請參閱貢獻指南，以了解如何為該專案做出貢獻的資訊。這包括建立問題、提交拉取請求以及設定開發環境。

建構說明

有關如何建立專案的信息，請參閱 CheckStyle 文件。

回饋與支持

• 造訪我們的討論頁面，您可以在其中提出問題並與其他使用者和貢獻者討論專案。這是我們針對使用和配置問題、偵錯和其他回饋等主題的首選溝通方法。
• Stack Overflow 是另一個詢問有關 Checkstyle 使用問題的地方。
• 如果您有興趣為該專案做出貢獻，可以加入我們的 Discord 貢獻者聊天。
• 我們的 Google 網路論壇是一個用於討論和支援的郵件清單；然而，我們的反應可能會很慢。

Java文檔

查看我們的 javadoc 以查看我們的 API 文件。

贊助方格風格

Checkstyle 是一個由志工開發和維護的開源專案。如果您發現 Checkstyle 有用，請考慮贊助專案。您的支持有助於我們維護和改進 Checkstyle。

• 自由支付
• 開放集體

授權

Checkstyle 根據 GNU LGPL v2.1 授權許可。 Checkstyle 使用函式庫：

• ANTLR
• 阿帕契共享區
• 谷歌番石榴
• 皮科利