checkstyle/checkstyle

来源：https://github.com/checkstyle/checkstyle

Checkstyle - Java 代码质量工具

Checkstyle 是一款用于确保代码符合特定标准或最佳实践的工具。

最新发布版本可在 GitHub 发布页面（https://github.com/checkstyle/checkstyle/releases/）或 Maven 仓库（https://repo1.maven.org/maven2/com/puppycrawl/tools/checkstyle/）中获取。
文档提供 HTML 格式，请参阅 Checkstyle 检查项。
来自 master 分支的最新部署网站可在此处访问：最新站点。

目录

• 快速开始
• 参与贡献
• 反馈与支持
• Javadoc
• 赞助 Checkstyle
• 许可协议

快速开始

• 从 GitHub 下载最新发布版本（https://github.com/checkstyle/checkstyle/releases/），或通过 Maven Central 将 Checkstyle 添加到构建配置中。
• 阅读我们的文档以了解使用方法（https://checkstyle.org/cmdline.html）和配置方式（https://checkstyle.org/config.html）。

$ cat config.xml  
$ cat Test.java  
class Test {  
    public void foo() {  
        int i = 0;  
        while (i >= 0) {  
            switch (i) {  
                case 1:  
                case 2:  
                    i++;  
                case 3:  
                    // 违规：'从前一个分支落入'  
                    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 做出贡献！请参阅贡献指南了解如何参与项目，包括创建 issue、提交拉取请求以及设置开发环境。

构建说明

请参阅构建说明了解如何构建项目。

反馈与支持

• 访问我们的讨论区，在此可以提问并与其他用户和贡献者讨论项目。这是我们沟通使用、配置问题、调试及其他反馈的首选方式。
• Stack Overflow（https://stackoverflow.com/questions/tagged/checkstyle）是另一个咨询 Checkstyle 使用问题的平台。
• 如果您有兴趣参与项目，可以加入我们的 Discord 贡献者聊天频道（https://discord.com/channels/845645228467159061/1216455699488313554），邀请链接为（https://discord.gg/FsUsYC2ura）。
• 我们的 Google Groups 论坛（https://groups.google.com/forum/?hl=en#!forum/checkstyle）是用于讨论和支持的邮件列表；但我们在该处的回复可能较慢。

Javadoc

查阅我们的 javadoc（https://checkstyle.org/apidocs/index.html）了解 API 文档。

赞助 Checkstyle

Checkstyle 是由志愿者开发和维护的开源项目。如果您觉得 Checkstyle 有用，请考虑赞助该项目。您的支持帮助我们维护和改进 Checkstyle。

• Liberapay（https://liberapay.com/checkstyle/）
• OpenCollective（https://opencollective.com/checkstyle/）

许可协议

Checkstyle 采用 GNU LGPL v2.1 许可证 授权。
Checkstyle 使用的库：

• ANTLR（https://www.antlr.org/）
• Apache Commons（https://commons.apache.org/）
• Google Guava（https://github.com/google/guava/）
• Picocli（https://github.com/remkop/picocli/）

开发工具

由以下支持