跳转至

Java

Java 规则

命名规则

类别 规则 描述
类名、接口名、枚举名、注解名 大驼峰命名法 每个单词的首字母大写，不使用下划线。应使用名词或名词短语
方法名 小驼峰命名法 第一个单词首字母小写，后面每个单词首字母大写。应使用动词或动词短语
变量名（实例变量、局部变量、参数） 小驼峰命名法 与方法名规则相同。应简短且具有描述性
常量名 所有字母大写，单词间用下划线分隔 使用 static final 修饰的字段被视为常量
包名 全部使用小写字母 通常使用公司域名的反写，以确保唯一性。各部分用 . 分隔

格式规则

缩进

统一使用 4 个空格进行缩进。严禁使用 Tab 键，因为不同环境下 Tab 的显示宽度可能不同。现代 IDE 可以自动将 Tab 转换为空格

花括号

广泛采用 K&R 风格：左花括号 { 放在语句的末尾，右花括号 } 单独一行，并与原语句的开头对齐

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
// 类和方法
public class MyClass {
    public void myMethod() {
        if (condition) {
            // ...
        } else {
            // ...
        }
    }
}

// 行尾可以跟注释
if (condition) {  // 检查条件
    // ...
}

空格和换行

  1. 关键字后加空格：if (， while (， for (。
  2. 操作符两边加空格：int sum = a + b;， if (a == b)。
  3. 逗号后加空格：method(arg1, arg2, arg3)。
  4. 方法间、逻辑块间空一行：在不同方法之间，以及方法内较大的逻辑块之间，插入一个空行，增加可读性。
  5. 控制语句：if, for, while 等语句即使只有一行代码，也建议使用 {}，以避免潜在的逻辑错误

行长限制

单行代码长度通常建议限制在 80 到 120 个字符以内。超长的行应进行合理换行

换行技巧：

  1. 在逗号后换行
  2. 在操作符前换行
  3. 下一行代码与上一行的同级表达式对齐
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
// 方法调用换行
String longString = someVeryLongMethodName(
        argument1, argument2, argument3);

// 链式调用换行（点号在前是常见做法）
StringBuilder sb = new StringBuilder()
        .append("Hello, ")
        .append(name)
        .append("!")
        .toString();

评论区

欢迎在评论区指出文档错误，为文档提供宝贵意见，或写下你的疑问