8语法和空格规范

JAVA编程规范语法和空格规范
文档编号
版本 1.0
JAVA编程规范
语法规范
空格规范
1．引言
本文档对Java代码的编程方式、风格做了统一规范，目的是减少编程人员代码编写中的语法错误，并通过增强代码的通读性和易懂性，使得代码修改和程序维护相对简单。

本文档可用作公司新进人员的培训材料，也可用作检查代码编写质量的参考。

2．语法规范
2.1简单语句
每一行只能有一条语句。

例如：
argv++;//正确
argc++;//正确
argv++;argc--;//错误!
2.2复合语句
如果语句中包含有被花括弧括起来的“{statements}”代码段，则该语句称为复合语句。

遵循下面的代码规范：
●被括弧{}括起来的语句至少要和复合语句有一级以上的缩进
●开括弧“{”必须在复合语句开始行的末尾。

闭括弧“}”必须单起一行，并且和复
合语句的起始具有同样的缩进位置
●所有的语句都必须被括弧括起来，当一条简单语句作为控制语句的一部分时也要这
样做，例如在if-else或for语句中。

这样添加语句时就不会因为忘记加括弧而
导致的程序bug。

2.3返回语句
具有返回值的返回语句不应当使用圆括弧，除非这样可以使得返回值比较清晰。

例如：return;
return myDisk.size();
return(size?size:defaultSize);
2.4if,if-else,if else-if else语句
if-else语句应具有以下形式：
if(condition){
statements;
}
if(condition){
statements;
}else{
statements;
}
if(condition){
statements;
}else if(condition){
statements;
}else{
statements;
}
注:if语句必须使用括弧{}，不允许使用下面错误语句：
if(condition)//错误!忽略了括弧{}!
statement;
2.5for语句
for语句应具有以下形式：
for(initialization;condition;update){
statements;
}
一个空的for语句（所有的操作在初始化、条件和更新子句中完成）应当具有以下形式：for(initialization;condition;update);
在for语句的初始化和更新子句中使用逗号时，避免使用超出3个以上的变量。

若有需要，使用另外的语句在for循环之前做初始化子句的工作，在每次循环结束时作更新子句里要做
的工作。

2.6while语句
while语句应具有以下形式：
while(condition){
statements;
}
空while语句应当具有以下形式：while(condition);
2.7do-while语句
do-while语句应具有以下形式：
do{
statements;
}while(condition);
2.8switch语句
switch语句应具有以下形式：
switch(condition){
case ABC:
statements;
/*falls through*/
case DEF:
statements;
break;
case XYZ:
statements;
break;
default:
statements;
break;
}
如果某个case子句中没有包含break语句，必须在通常break的位置加上注释（/*falls through*/），注释的内容和格式参考以前的注释规范。

每个switch语句必须有一个默认选择（default），在默认选择里也必须有break语句，可以防止以后增加case语句时出现遍历错误。

注：表达式condition的返回值类型必须是这几种类型之一：int，byte，char，short。

2.9try-catch语句
try-catch语句应具有以下形式：
try{
statements;
}catch(ExceptionClass e){
statements;
}
try-catch语句可能跟随有finally语句，其作用是不管try语句执行成功与否，finally语句都无条件的执行。

try{
statements;
}catch(ExceptionClass e){
statements;
}finally{
statements;
}
3．空格规范
3.1空行
通过空行，逻辑相关的代码被分隔成一个个代码片断，从而改善了程序的易读性。

在以下情况使用两行空行分隔
●不同的类和接口定义之间
在以下情况使用一行空行分隔
●不同的方法体之间
●在方法内部，变量声明和第一行语句之间
●在块注释（参考5.1.1）或单行注释（参考5.1.2）之间
●方法内部为改善易读性而把分隔成不同的逻辑片段之间
3.2空格
在以下情况使用空格符：
●关键字后跟圆括弧时必须用一个空格隔开。

例如：
while(true){
...
}
注意：方法名和其后的括弧之间不能有空格，这是为了区分关键字和方法的不同调用。

●参数列表中的每一个逗号之后必须加一个空格
●所有的二元运算表达式，运算符和运算元之间必须用一个空格分开。

所有的一元运
算表达式，不允许在运算符和运算元之间使用空格。

象负值、递增(“++”)、递减
(“--”)，例如：
a+=c+d;
a=(a+b)/(c*d);
while(d++=s++){
n++;
}
prints(“size is“+foo+“\n”);
●for语句的各个表达式之间必须用一个空格分开。

例如：
for(expr1;expr2;expr3)
●类型转换必须加一个空格。

例如：
myMethod((byte)aNum,(Object)x);
myMethod((int)(cp+5),((int)(i+3))+1);
●“{”之前必须有一个空格，“}”和其后代码之间也必须有一个空格。

附录A文档更新记录。