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
• 阿帕奇共享区
• 谷歌番石榴
• 皮科利