Java代码规范

命名规范
1.名字应该能够标识事物的特性，并且与业务挂钩。
2.名字一律使用英文单词，而不能为拼音。
3.名字可以有两个或三个单词组成，但不应多于4个，控制在3至30个字母以内。
4.在名字中，多个单词用大写第一个字母（其它字母小写）来分隔。例如：IsSuperUser。
5.命名避免和以下关键字冲突
如：Base，Date，Class……
6.方法名、参数名统一使用驼峰命名法（Camel命名法），除首字母外，其他单词的首字
母大写，其他字母小写，类名每个组合的单词都要大写；
正例：localValue/getHttpMessage()/inputUserId

注释规范
1.一般情况下，源程序的有效注释量必须在30%以上。
2.避免使用装饰性内容，保持注释的简洁。
3.注释信息不仅要包括代码的功能，还应给出原因，不要为注释而注释。
4.除变量定义等较短语句的注释可用行尾注释外，其他注释当避免使用行尾注释。
5.注释类型：javadoc注释，失效代码注释(eclipse下ctrl+shift+/),代码细节注释//。
6.对类、方法、变量等的注释需要符合JavaDoc规范，对每个类、方法都应详细说明其
功能、条件、参数等，并使用良好的HTML标记
7.格式化注释，以使生成的JavaDoc易阅读和理解。
8.如果注释太复杂说明程序需要修改调整，使设计更加合理。
9.getter、setter方法不用注释
10.注释不能嵌套
11.生成开发文档的需要用中文编写
12.如果需要注释的内容太多，需附加文档进行说明，注释时加上"参见《****》"
13.距离较远的}必须注释
14.复杂的分支流程必须注释
15.代码质量不高但能正常运行，或者还没有实现的代码用//TODO:声明
16.存在错误隐患的代码用//FIXME:声明

语句规则
原则：

1.统一使用Eclipse格式化工具进行格式化，默认快捷键：Ctrl+Shift+F
2.尽量避免强制类型转换。如果不得不做类型转换，尽量用显式方式。
3.Ifelse中的业务代码行数太长，否则就要考虑用函数封装
4.避免在表达式中用赋值语句
5.避免对浮点类型做等于或不等于判断
6.杜绝魔法数字，for循环的最大数等也要用变量代替，以便知道是什么含义
7.对象比较运算，常量放在前面，比如"aaa".equals(str)
8.Boolean的"假"判断格式：if(false==isMax)而不用if(!isMax)，因为非符号"！"不
清晰
9.如果一段带有业务逻辑的代码超过两次用到，就将其封装成一个方法
10.单个循环也要用{}
11.每个变量仅有一个唯一的用途
12.单个函数执行单个功能并与其命名相符
13.消除所有编译器警告
14.常数变量声明为final
15.每个if-elseif-else语句都有最后一个else以确保处理了全集
16.对于流操作代码的异常捕获有finally操作以关闭流对象，比如：
在这里插入图片描述
17.对同步对象的遍历访问必须进行代码同步处理
18.在对Map对象使用迭代遍历过程中保证没有做增减元素操作
19.Ifelse判断语句避免头重脚轻，比如if的代码段过大，else的代码很短，这时候要调
整结构。
20.每一行最多包含一条语句。

循环语句：
1.务必检查，杜绝死循环
2.即使循环体只有一条语句，也要用花括号括起
3.尽量不用空语句，特殊情况用到空语句，写好注释，告诉读者这不是bug
4.循环中禁止使用访问数据库的操作，循环内部如果需与数据库交互，而应提前一次性
读取出。
比如：Switch-case
1.语句switch中的每个case各占一行。
2.所有的非空case语句必须用break;语句结束。例：
在这里插入图片描述
3.语句switch中的case按字母顺序排列。
4.为所有switch语句提供default分支。

编码风格规则
编码过程中需遵循以下风格习惯：
1.代码未写，文档先行，注释必须按照固定统一范式撰写。
2.关系运算必须常量在左、变量在右。
3.不许使用复杂的运算表达式，必要时添加括号而不依赖于优先级。
4.局部变量必须初定义、避免不必要的内存操作、内存操作必须考虑异常处理。