Java 代码格式化:约定

Java 代码格式化:约定

Java 是约定最多的语言之一——它的风格指南早于多数语言,且被每个认真的团队执行。下面这些规则,是评审会注意到的。

重要的约定

  • 类用大驼峰(PascalCase),方法和变量用小驼峰(camelCase),常量全大写蛇形——Java 的命名三位一体。
  • 花括号同行(K&R 风格):if (x) {——不在新行。这是 Java 与 C# 分道扬镳的唯一风格选择。
  • 4 空格缩进,不用制表符。
  • 一行一条语句;空行分隔逻辑块。
  • 重写的方法加 @Override——编译器强制;漏掉它在评审里是红旗。

为什么 Java 的格式化更重要

Java 代码活得久——系统跑几十年,代码经过无数双手。一致的风格让二十年前的文件读起来像昨天写的。它也让静态分析和 diff 评审保持可用:统一的代码产生干净的 diff。

格式化方法

  1. 把代码粘进 Java 格式化工具。
  2. 工具套用标准约定——缩进、花括号位置、空格。
  3. 复制结果。团队层面,在 CI 里接入自动化格式化,风格之争就不会走到评审环节。

一句实话

Java 的啰嗦是设计的一部分——显式类型、显式花括号、显式一切。格式化后的 Java 还是 Java;只是读起来顺滑。目标不是更少字符,而是让下一个维护者少受惊吓。

风格指南只有自动化才有效。格式化工具把“风格”从评审争吵变成构建步骤——那才是它该待的地方。