JAVA代码规范（一）

编码规范很重要，这里就不说为什么重要了。

以下内容会由于个人的情况不同会出现一些调整，这里提供一个参考。

1.文件组织

程序行数不宜过多，注释和空行分割应合理。

 

2.源文件

 

每个JAVA源文件都包含一个单一的公共类或接口，且公共类必须是这里的第一个类。

 

3.开头注释

 

根据个人需要，最好列出类名，版本信息，日期，等等。

 

4.包和引入语句

 

第一个非注释行是包语句，其后可以跟引入语句。

 

5.缩进

 

使用4个空格作为缩进单位，或将TAB键的占位符设置为4.

 

6.排版

 

避免再一个语句里给多个变量赋值。

参数列表的逗号后面应有一个空格。（包括for语句）

二元运算符除了“.”，应该使用空格符将之与操作数分开。

 

7.行长度

 

尽量避免一行的长度超过150字符。

 

8.换行

 

每行只能有一个声明。

两个方法之间使用空行。

当表达式无法容纳在一行内的时候，

可以用{}换行，

在逗号或操作符前面断开，

新的一行应该与同级的表达式对齐。

 

9.注释

 

注释不应写在大框里，注释里不应包括制表符和回退符等特殊字符。

注释风格大概有四种：

块，

单行，

尾端，

行末。

不要在应保持注释一致性的时候使用复数的注释风格。

 

10.javadoc注释

 

对类，接口，公用和保护类变量使用javadoc注释，必须包括描述，参数，返回值，异常的说明。

 

11.注释格式

 

方法的内部采用单行注释，不要和代码同一行。

 

12.类内部的成员变量

 

单行注释。

 

13.声明

 

一行一个声明。

 

14.初始化

 

尽量在声明局部变量的同事初始化。

 

15.布局

 

在代码块的开始处声明变量，将局部变量的作用域最小化。

 

16.类和接口的声明

 

方法名与其参数列表之前的左括号间不要有空格。

左大括号位于声明语句的同行末尾。

方法与方法之间以空行分隔。

 

17.简单语句

 

每行最多包含一条语句。

 

18.复合语句

 

左大括号应该位于起始行的末尾，右大括号应另起一行并与复合语句首行对齐。

即使是单行的if-else语句或for语句，也建议加上大括号，这样可以有效防止因为添加语句后而忘了加大括号的行为。

 

19.返回语句

 

一个带返回值的语句一般不使用小括号，除了以下情况

return；

return myDisk.size();

return (size?size:defaultSize);

 

20.块语句

 

if，else，while，for语句必须有{}，空格。

{必须在一行之末，}在一行之头。

 

21.命名规范

 

包路径必须小写。

类名应该是名词，或者是名词+动词

接口的第一个字母大写。

多个单词合成的一个类名，每个单词首字母大写。

数据访问用表明+DAO+方言方式。

接口首字母为I。

方法用驼峰命名法。

数组用byte[] buffer;而不是byte buffer[];，根绝类名首字母小写，数组增加Arr后缀。

变量用匈牙利命名。

常量全大写，使用关键字final。中间用下划线分割单词。

组件命名以相应组件结尾。