java代码规范
Java代码规范
规范类型 |
规范要求 |
命名规范 |
- 类名:大写字母开头,驼峰命名法。<br>- 方法名、变量名、包名:小写字母开头,驼峰命名法。<br>- 常量:全大写字母,下划线分隔单词。 |
缩进和空格 |
- 使用 4 个空格进行缩进,不使用制表符。<br>- 二元运算符前后应该加上空格,以增加代码的可读性。 |
注释规范 |
- 使用 Javadoc 风格的注释来描述类、方法和字段的作用。<br>- 在每个方法之前添加注释,描述方法的功能、参数和返回值。 |
类和方法设计 |
- 遵循单一职责原则,确保每个类和方法只有一个明确的功能。<br>- 避免过长或过于复杂的方法,保持简洁和可读性。 |
异常处理 |
- 在必要的地方捕获异常,并进行适当的处理或记录。<br>- 不要捕获所有异常,只捕获能够处理的异常类型。 |
包和导入 |
- 包名使用小写字母,并与文件路径匹配。<br>- 导入语句按字母顺序排列,分组并按标准顺序排列(包、空行、静态导入)。 |
其他规范 |
- 避免使用魔法数值,将其定义为常量。<br>- 使用 final 关键字声明不可变的变量和不可继承的类。 |