java代码风格_Java代码风格，掌握了这些你就可以成为架构师

命名规约

1.命名符合本语言特性

Java中所有的代码元素的命名均不能以下划线或美元符号开始或结束。

2.命名体现代码元素特征

要从名字上就知道代码元素的属性是什么，有利于快速理清代码脉络。代码的命名形式分为两大类：即首字母大写UpperCamelCase和首字母小写lowerCamelCase，前者俗称大驼峰，后者俗称小驼峰。

推荐在Java命名时，以下列方式体现元素特征：

*包名统一小写，点分隔符之间有且仅有一个自然语义的英文单词。统一使用单数形式。

*抽象类命名使用Abstract或Base开头；异常类命名使用Exception结尾；测试雷鸣以它要测试的类名开始，以Test结尾。

*类型与中括号紧挨相连来定义数组。

*枚举类名带上Enum后缀，枚举成员名称需要全大写，单词间用下划线隔开。

3.命名最好望文知意

代码风格展示

1.缩进

在IDEA中设置Tab键为4个空格时，请勿勾选Use tab character;

在Eclipes中，必须勾选Insert spaces for tabs.

2.空格

空格的使用有如下约定：

(1)任何二目、三目运算符的左右两边都必须加一个空格

(2)注释的双斜线与注释内容之间有且仅有一个空格

(3)方法参数在定义和传入时，多个参数逗号后面必须加空格

(4)没有必要增加若干空格使变量的赋值等号与上一行对应位置的等号对齐

(5)如果是大括号内为空，则简洁地写成{}即可，大括号中间无需换行和空格

(6)左右小括号与括号内部地相邻字符之间不要出现空格

(7)左大括号前需要加空格

3.空行

空行用来分割功能相似、逻辑内聚、意思相近地代码片段。在方法定义之后、属性定义与方法之间、不同逻辑、不同语义、不同业务地代码之间都需要通过空行来分隔。

4.换行

在代码中需要限定每行地字符个数，以便适应显示器地宽度。约定：单行字符数不超过120个，超出则需要换行，需要遵循如下原则:

1.第二行相对第一行缩进4个空格，从第三行开始，不再继续缩进

2.运算符与下文一起换行

3.方法调用的点符号与下文一起换行

4.方法调用中的多个参数需要换行时，在逗号后换行

5.在括号前不要换行

5.方法行数限制

约定单行方法的总行数不超过80行。

控制语句

1.在if 、else、for、while、do-while等语句中必须使用大括号

即使只有一行代码，也要加上大括号

2.在条件表达式中不允许有赋值才做，也不允许在判断表达式中出现复杂的逻辑组合

3.多层嵌套不能超过3层

4.避免采用取反逻辑运算符

取反逻辑运算符不易理解

代码注释

注释三要素

1.Nothing is strange

代码中不能没有注释！

2.Less is more

首先，代码的注释一定是精华中的精华！

其次，注释要简练，不能长篇大论。

最后，一些简单方法常识性的方法无需注释

3.Advance with the times

任何对于代码的修改，都应该同时修改注释

注释格式

1.Javadoc规范

使用文档注释(/** */)的格式，方便生成文档。

这里特别强调的是枚举的注释，枚举的注释是必须要有的，因为：

1.枚举实在太特殊了，它的代码极其稳定

2.注释的内容不仅限于解释属性值的含义，还可以包括注意事项、业务逻辑

3.枚举类的删除或者修改都存在很大的风险

2.简单注释