双人项目代码规范

阅读《Java开发手册》和《华为编程规范》后，对双人项目的Java代码规范制定的简易规范。

一、标识符命名

1. 标识符的命名力求做到统一、达意和简洁。统一：同一概念用同种表示方法。即使不能取得好的名称也要保证阅读者容易理解。达意：标识符能准确的表达出它所代表的意义。简洁：在统一和达意的前提下，用尽量少的标识符。
2. 除包名，静态常量等特殊情况，大部分情况下标识符使用骆驼法则。
3. 类名：首字母大写。首字母小写，动词在前。
4. 静态常量、枚举：尽量全大写用下划线分割。

二、代码格式

1. 括号：大括号的开始在代码块开始的行尾，闭合在和代码块同一缩进的行首。
2. 缩进：4个空格作为缩进排版的一个单位，显示程序的层次级别，增加程序的可读性。
3. 行长度：尽量避免一行的长度超过80个字符。
4. 空行空格：注意空格空行的使用。关键字和括号之间有空格，第一个参数和最后一个参数和括号无空格；二元运算符等。类声明和接口声明之间；两个方法之间；方法内的局部变量和方法的第一条语句之间；块注释或单行注释之前；一个方法内的两个逻辑段之间。
5. 程序块的分界符（如C/C++语言的大括号‘{’和‘}’）应各独占一行并 且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。

三、注释规范

1. 注释简单、明了、含义准确，防止注释的多义性，同步代码。
2. 文档注释：/**......*/所以注释文档必须书写在类、域、构造函数、方法，以及字段(field)定义之前. 注释文档由两部分组成——描述、块标记。
3. 注释部分：

　　　　java文件：版权信息、创建时间、创建人

　　　　类：目的、所完成功能、版权信息、创建人

　　　　方法：参数含义、返回值

　　　　属性：字段描述

　　　　接口：目的、创建人、版本号、创建时间

 

四、其他

1. 可使用log替换System.out.println()
2. 在需要留空的地方放一个空语句或注释
3. 合并减少代码嵌套层次，如：利用 return 以省略后面的else。4. 利用子方法，就是将嵌套的程序提取出来放到另外的方法里。