Java基础编码规范

1.布局

1.1顺序
(1)在一个类中，布局顺序一次是:变量，构造器，方法，内部类，main
(2)类中变量/方法的布局顺序:public static,public,protected.package,private
(3)构造器多个时，参数少在前，参数多在后
(4)函数重载要集中在一起声明
1.2高度
(1)每行只有一个句子
(2)方法不要超过一屏幕(20-50行)
1.3宽度
(1)每行不能超过120个字符，对于超过120个字符需要断行缩进
(2)方法入参小于5个
1.4深度
(1)方法圈复杂度小于5优秀，8-10一般
1.5密度
运算符和操作数之间要有空格，除++，–之外

2.命名

(1)只能由26个英文字母和10个数字以及下划线组成
(2)程序中不要出现易混淆的标识名称
(3)包名全部小写，不使用下划线，以com.xxx公司缩写
(4)类名首字母大写，不用下划线，采用UpperCamelCase形式，对于特殊类型，例如工具类Util,异常Exception等都统一规范命名
(5)方法名，首字母小写的lowerCamelCase，不使用下划线，对于返回boolean类型的，方法名一般以is,have,can,has开头
(6)变量，常量静态字段全部大小，多个单词之间采用下划线，例如public static final int PROTOCOL_NAME=“tcp”;,避免无意义字符

3.声明

(1)基础变量，尽可能使用基础类型，例如int,long而不是Integer,Long
(2)声明long变量时，使用大写字符L，例如long data=2L
(3)多维数组如果在定义初始化，对数组的矩阵结构分行书写
(4)如果没有使用任务实例类成员，包括方法和字段，那么就把方法声明为静态的或者放入IOC容器，静态方法过多时可以考虑放到Util类

4.注释

(1)无用的注释，没必要的注释不要写
(2)注释符与注释内容之间要有一个空格
(3)特殊注释标记，请注明标记人和标记时间，注释及时处理这些标记，例如常见的//TODO(zhangsan,2022-01-12) 标记
(4)文档类注释，必须使用javadoc规范，使用/*内容/格式，代码修改时，同步修改javadoc,应该说明设计思路，而不是描述代码的行为

5.异常

(1)除了最外层方法，finaliy{},禁止直接catch异常Exception或者Throwable,而应该捕获具体的异常类型
不能在finally中return,可在catch中

6.工程

代码规范插件 IDEA+Guildlines插件