Java 代码规范

文章内容
  1. Checkstyle

Java 常用代码规范检查工具如下:

工具 lint 命令 支持 IDE
Checkstyle ./gradlew check VSCodeIDEA
PMD pmd -d src -R rulesets.xml VSCode

Checkstyle

Checkstyle 内置 2 种规范——Google 与 Sun,其中常用的「Google Java Style」规范包括下列规则:

  • 每行代码最大长度 100 个字符;
  • 缩进使用 2 个空格;

安装:

$ vi build.gradle
    plugins {
        id 'checkstyle'
    }
    checkstyle {
        toolVersion = '8.34'
        maxWarnings = 0
        maxErrors = 0
    }
$ wget https://raw.githubusercontent.com/checkstyle/checkstyle/checkstyle-8.34/src/main/resources/google_checks.xml -O config/checkstyle/checkstyle.xml

全量检查:

$ ./gradlew check

[WARN] TaskTest.java:543: 本行字符数 101个,最多:100个。 [LineLength]
[WARN] ReportTest.java:206:9: 第 9 个字符 '}'应该与下一部分位于同一行。
[WARN] ProjectRoleTest.java:449:8: 注释应缩进8个缩进符,而不是7个。
上一篇PHP 代码规范
文档是否对您有用?
感谢反馈有用
感谢反馈没用