服务热线:13616026886

技术文档 欢迎使用技术文档,我们为你提供从新手到专业开发者的所有资源,你也可以通过它日益精进

位置:首页 > 技术文档 > JAVA > 新手入门 > 基础入门 > 查看文档

java语言编码规范(2)


  6.3 布局(placement)

只在代码块的开始处声明变量。(一个块是指任何被包含在大括号"{"和"}"中间的代码。)不要在首次用到该变量时才声明之。这会把注意力不集中的程序员搞糊涂,同时会妨碍代码在该作用域内的可移植性。


void mymethod() {
int int1 = 0; // beginning of method block

if (condition) {
int int2 = 0; // beginning of "if" block
...
}
}


该规则的一个例外是for循环的索引变量


for (int i = 0; i < maxloops; i++) { ... }


避免声明的局部变量覆盖上一级声明的变量。例如,不要在内部代码块中声明相同的变量名:


int count;
...
mymethod() {
if (condition) {
int count = 0; // avoid!
...
}
...
}


6.4 类和接口的声明(class and interface declarations)

当编写类和接口是,应该遵守以下格式规则:

- 在方法名与其参数列表之前的左括号"("间不要有空格
- 左大括号"{"位于声明语句同行的末尾
- 右大括号"}"另起一行,与相应的声明语句对齐,除非是一个空语句,"}"应紧跟在"{"之后

class sample extends object {
int ivar1;
int ivar2;

sample(int i, int j) {
ivar1 = i;
ivar2 = j;
}

int emptymethod() {}

...
}

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

7 语句(statements)

7.1 简单语句(simple statements)

每行至多包含一条语句,例如:


argv++; // correct
argc--; // correct
argv++; argc--; // avoid!


7.2 复合语句(compound statements)

复合语句是包含在大括号中的语句序列,形如"{ 语句 }"。例如下面各段。

- 被括其中的语句应该较之复合语句缩进一个层次
- 左大括号"{"应位于复合语句起始行的行尾;右大括号"}"应另起一行并与复合语句首行对齐。
- 大括号可以被用于所有语句,包括单个语句,只要这些语句是诸如if-else或for控制结构的一部分。这样便于添加语句而无需担心由于忘了加括号而引入bug。

7.3 返回语句(return statements)

一个带返回值的return语句不使用小括号"()",除非它们以某种方式使返回值更为显见。例如:


return;

return mydisk.size();

return (size ? size : defaultsize);


7.4 if,if-else,if else-if else语句(if, if-else, if else-if else statements)

if-else语句应该具有如下格式:


if (condition) {
statements;
}

if (condition) {
statements;
} else {
statements;
}

if (condition) {
statements;
} else if (condition) {
statements;
} else{
statements;
}


注意:if语句总是用"{"和"}"括起来,避免使用如下容易引起错误的格式:


if (condition) //avoid! this om99vs the braces {}!
statement;


7.5 for语句(for statements)

一个for语句应该具有如下格式:


for (initialization; condition; update) {
statements;
}


一个空的for语句(所有工作都在初始化,条件判断,更新子句中完成)应该具有如下格式:


for (initialization; condition; update);


当在for语句的初始化或更新子句中使用逗号时,避免因使用三个以上变量,而导致复杂度提高。若需要,可以在for循环之前(为初始化子句)或for循环末尾(为更新子句)使用单独的语句。

7.6 while语句(while statements)

一个while语句应该具有如下格式


while (condition) {
statements;
}


一个空的while语句应该具有如下格式:


while (condition);


7.7 do-while语句(do-while statements)

一个do-while语句应该具有如下格式:


do {
statements;
} while (condition);


7.8 switch语句(switch statements)

一个switch语句应该具有如下格式:


switch (condition) {
case abc:
statements;
/* falls through */
case def:
statements;
break;

case xyz:
statements;
break;

default:
statements;
break;
}


每当一个case顺着往下执行时(因为没有break语句),通常应在break语句的位置添加注释。上面的示例代码中就包含注释/* falls through */。

7.9 try-catch语句(try-catch statements)

一个try-catch语句应该具有如下格式:


try {
statements;
} catch (exceptionclass e) {
statements;
}


一个try-catch语句后面也可能跟着一个finally语句,不论try代码块是否顺利执行完,它都会被执行。


try {
statements;
} catch (exceptionclass e) {
statements;
} finally {
statements;
}
8 空白(white space)
8.1 空行(blank lines)
空行将逻辑相关的代码段分隔开,以提高可读性。
下列情况应该总是使用两个空行:
- 一个源文件的两个片段(section)之间
- 类声明和接口声明之间
下列情况应该总是使用一个空行:
- 两个方法之间
- 方法内的局部变量和方法的第一条语句之间
- 块注释(参见"5.1.1")或单行注释(参见"5.1.2")之前
- 一个方法内的两个逻辑段之间,用以提高可读性
8.2 空格(blank spaces)
下列情况应该使用空格:
- 一个紧跟着括号的关键字应该被空格分开,例如:
while (true) {
...
}

注意:空格不应该置于方法名与其左括号之间。这将有助于区分关键字和方法调用。
- 空白应该位于参数列表中逗号的后面
- 所有的二元运算符,除了".",应该使用空格将之与操作数分开。一元操作符和操作数之间不因该加空格,比如:负号("-")、自增("++")和自减("--")。例如:
a += c + d;
a = (a + b) / (c * d);

while (d++ = s++) {
n++;
}
printsize("size is " + foo + "/n");

- for语句中的表达式应该被空格分开,例如:
for (expr1; expr2; expr3)

- 强制转型后应该跟一个空格,例如:
mymethod((byte) anum, (object) x);
mymethod((int) (cp + 5), ((int) (i + 3)) + 1);

9 命名规范(naming conventions)
命名规范使程序更易读,从而更易于理解。它们也可以提供一些有关标识符功能的信息,以助于理解代码,例如,不论它是一个常量,包,还是类。
标识符类型 命名规则 例子
包(packages) 一个唯一包名的前缀总是全部小写的ascii字母并且是一个顶级域名,通常是com,edu,gov,mil,net,org,或1981年iso 3166标准所指定的标识国家的英文双字符代码。包名的后续部分根据不同机构各自内部的命名规范而不尽相同。这类命名规范可能以特定目录名的组成来区分部门(department),项目(project),机器(machine),或注册名(login names)。 com.sun.engcom.apple.quicktime.v2edu.cmu.cs.bovik.cheese
类(classes) 命名规则:类名是个一名词,采用大小写混合的方式,每个单词的首字母大写。尽量使你的类名简洁而富于描述。使用完整单词,避免缩写词(除非该缩写词被更广泛使用,像url,html) class raster;class imagesprite;
接口(interfaces) 命名规则:大小写规则与类名相似 interface rasterdelegate;interface storing;
方法(methods) 方法名是一个动词,采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写。 run();runfast();getbackground();
变量(variables) 除了变量名外,所有实例,包括类,类常量,均采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写。变量名不应以下划线或美元符号开头,尽管这在语法上是允许的。变量名应简短且富于描述。变量名的选用应该易于记忆,即,能够指出其用途。尽量避免单个字符的变量名,除非是一次性的临时变量。临时变量通常被取名为i,j,k,m和n,它们一般用于整型;c,d,e,它们一般用于字符型。 char c;int i;float mywidth;
实例变量(instance variables) 大小写规则和变量名相似,除了前面需要一个下划线 int _employeei

扫描关注微信公众号