《事业-最佳实践-编码》系列

原则

• 含义准确

• 见名知意

• 遵守命名规范

• 可读性优先

规范

包名（Package Names）

• 包名应该小写，使用小写字母和点（.）组合而成，例如：com.example.project。

• 避免使用 Java 保留字或常见的缩写作为包名，以避免潜在的命名冲突。

类名（Class Names）

• 类名应该采用驼峰式命名法，即每个单词的首字母大写，例如：MyClassName。

• 类名应该清晰表达其用途，避免使用过于简单或无意义的名称。

接口名（Interface Names）

• 接口名也应该采用驼峰式命名法，具体两种可选，团队统一即可

• 以大写字母"I"开头，例如：IMyInterface，接口实现使用不包含 I 的单词如：MyInterface

• 不使用“I”开头，如 MyInterface，接口实现使用 MyInterfaceImpl

• 接口名应该清晰表达其定义的功能和用途。

方法名（Method Names）

• 方法名应该采用驼峰式命名法，第一个单词首字母小写，后续单词首字母大写，例如：myMethodName。

• 方法名应该清晰表达其执行的操作。

变量名（Variable Names）

• 变量名应该采用驼峰式命名法，第一个单词首字母小写，后续单词首字母大写，例如：myVariableName。

• 避免使用单个字符或缩写作为变量名，应该选择具有描述性的名称。

常量名（Constant Names）

• 常量名应该全部大写，并使用下划线分隔单词，例如：MY_CONSTANT_VALUE。

• 常量名应该尽可能清晰地描述其用途和取值。

枚举名（Enum Names）

• 枚举名应该采用驼峰式命名法，每个单词首字母大写，例如：MyEnumType。

• 枚举名应该表示其所代表的类型或类别。

避免使用单个字符命名

• 尽量避免使用单个字符作为类、方法或变量的名称，除非它们的用途非常明确和简单。