开发代码规范

发表于   |   分类于

命名规范(Naming Conventions)

命名规范使程序更易读，从而更易于理解。它们也可以提供一些有关标识符功能的信息，以助于理解代码，例如，不论它是一个常量，包，还是类。

识符类型 命名规则 例子
包(Packages) 一个唯一包名的前缀总是全部小写的ASCII字母并且是一个顶级域名，通常是com，edu，gov，mil，net，org，或1981年ISO 3166标准所指定的标识国家的英文双字符代码。包名的后续部分根据不同机构各自内部的命名规范而不尽相同。这类命名规范可能以特定目录名的组成来区分部门(department)，项目(project)，机器(machine)，或注册名(login names)。 com.mobogenie.view
com.mobogenie.quicktime.v2
类(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，它们一般用于字符型。 成员变量 String mName;
局部变量 String name;
静态变量 static String sName;
实例变量(InstanceVariables) 大小写规则和变量名相似,按驼峰命名法，成员变量以m开头，局部变量按普通方式生成 类的实例变量遵循以上规则(按照变量命名规则)
常量(Constants) 类常量和ANSI常量的声明，应该全部大写，单词间用下划线隔开。(尽量避免ANSI常量，容易引起错误) static final int MIN_WIDTH = 4;
static final int MAX_WIDTH = 999;
static final int GET_THE_CPU;

文件组织(File Organization)

Java源文件(Java Source Files)

每个Java源文件都包含一个单一的公共类或接口。若私有类和接口与一个公共类相关联，可以将它们和公共类放入同一个源文件。公共类必须是这个文件中的第一个类或接口。

Java源文件还遵循以下规则：

  • 开头注释（参见”开头注释”）
  • 包和引入语句（参见”包和引入语句”）
  • 类和接口声明（参见”类和接口声明”）

开头注释(Beginning Comments)

所有的源文件都应该在开头有一个注释，其中列出类名、版本信息、日期和版权声明.

包和引入语句(Package and Import Statements)

在多数Java源文件中，第一个非注释行是包语句。在它之后可以跟引入语句。例如：

1
2
package java.awt;
import java.awt.peer.CanvasPeer;

类和接口声明(Class and Interface Declarations)

下表描述了类和接口声明的各个部分以及它们出现的先后次序。参见“Java源文件范例”中一个包含注释的例子。

类/接口声明的各部分 注解
1 类/接口文档注释(/*……/) 该注释中所需包含的信息，参见”文档注释”
类或接口的声明
类/接口实现的注释(/……/)如果有必要的话 该注释应包含任何有关整个类或接口的信息，而这些信息又不适合作为类/接口文档注释。
类的(静态)变量 首先是类的公共变量，随后是保护变量，再后是包一级别的变量(没有访问修饰符，access modifier)，最后是私有变量。
实例变量 首先是公共级别的，随后是保护级别的，再后是包一级别的(没有访问修饰符)，最后是私有级别的。
构造器
方法 这些方法应该按功能，而非作用域或访问权限，分组。例如，一个私有的类方法可以置于两个公有的实例方法之间。其目的是为了更便于阅读和理解代码。

编程惯例(Programming Practices)

提供对实例以及类变量的访问控制(Providing Access to Instance and Class Variables)

若没有足够理由，不要把实例或类变量声明为公有。通常，实例变量无需显式的设置(set)和获取(gotten)，通常这作为方法调用的边缘效应 (side effect)而产生。

一个具有公有实例变量的恰当例子，是类仅作为数据结构，没有行为。亦即，若你要使用一个结构(struct)而非一个类(如果java支持结构的话)，那么把类的实例变量声明为公有是合适的。

引用类变量和类方法(Referring to Class Variables and Methods)

避免用一个对象访问一个类的静态变量和方法。应该用类名替代。例如：

1
2
3
classMethod();             //OK
AClass.classMethod();      //OK
anObject.classMethod();    //AVOID!

常量(Constants)

位于for循环中作为计数器值的数字常量，除了-1,0和1之外，不应被直接写入代码。

变量赋值(Variable Assignments)

避免在一个语句中给多个变量赋相同的值。它很难读懂。例如：

1
fooBar.fChar = barFoo.lchar = 'c'; // AVOID!

不要将赋值运算符用在容易与相等关系运算符混淆的地方。例如：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
if (c++ = d++) { // AVOID! (Java disallows)
    //some code...
}

//应该写成
if ((c++ = d++) != 0) {
    //some code...
}

//不要使用内嵌(embedded)赋值运算符试图提高运行时的效率，这是编译器的工作。例如：

d = (a = b + c) + r;// AVOID!

//应该写成
a = b + c;
d = a + r;

其它惯例(Miscellaneous Practices)

  • 圆括号(Parentheses)

一般而言，在含有多种运算符的表达式中使用圆括号来避免运算符优先级问题，是个好方法。即使运算符的优先级对你而言可能很清楚，但对其他人未必如此。你不能假设别的程序员和你一样清楚运算符的优先级。

1
2
3
if (a == b && c == d) // AVOID!

if ((a == b) && (c == d)) // RIGHT
  • 返回值(Returning Values)

设法让你的程序结构符合目的。例如：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
if (booleanExpression) {
    return true;
} else {
    return false;
}

//应该代之以如下方法：
return booleanExpression;

//类似地：
if (condition) {
    return x;
}
return y;

//应该写做：
return (condition ? x : y);
  • 条件运算符”?”前的表达式(Expressions before ‘?’ in the Conditional Operator)

如果一个包含二元运算符的表达式出现在三元运算符” ? : “的”?”之前，那么应该给表达式添上一对圆括号。例如：

1
(x >= 0) ? x : -x;

语句(Statements)

简单语句(Simple Statements)

每行至多包含一条语句，例如：

1
2
3
4
5
argv++; // Correct

argc--; // Correct

argv++; argc--; // AVOID!

复合语句(Compound Statements)

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

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

返回语句(return Statements)

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

1
2
3
return;
return myDisk.size();
return (size ? size : defaultSize);

if，if-else，if else-if else语句(if, if-else, if else-if else Statements)

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
if (condition) {
    statements;
}

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

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

注意：if语句总是用”{“和”}”括起来，避免使用如下容易引起错误的格式：

1
2
if (condition) //AVOID! THIS OMITS THE BRACES {}!
    statement;

for语句(for Statements)

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

1
2
3
for (initialization; condition; update) {
    statements;
}

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

1
for (initialization; condition; update);

当在for语句的初始化或更新子句中使用逗号时，避免因使用三个以上变量，而导致复杂度提高。若需要，可以在for循环之前(为初始化子句)或for循环末尾(为更新子句)使用单独的语句。 ### 6 while语句(while Statements) 一个while语句应该具有如下格式

1
2
3
while (condition) {
    statements;
}

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
while (condition);
  ### 7 do-while语句(do-while Statements) 一个do-while语句应该具有如下格式：
do {
    statements;
} while (condition);
  ### 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 /。 ### 9 try-catch语句(try-catch Statements) 一个try-catch语句应该具有如下格式：

1
2
3
4
5
try {
    statements;
} catch (ExceptionClass e) {
    statements;
}

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

1
2
3
4
5
6
7
try {
statements;
} catch (ExceptionClass e) {
    statements;
} finally {
    statements;
}

代码范例(Code Examples)

Java源文件范例(Java Source File Example)

下面的例子，展示了如何合理布局一个包含单一公共类的Java源程序。接口的布局与其相似。更多信息参见”类和接口声明”以及”文挡注释”。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
package java.blah;
import java.blah.blahdy.BlahBlah;

/**
 * Class description goes here.
 *
 * @version 1.82 18 Mar 1999
 * @author Firstname Lastname
 */
public class Blah extends SomeClass {
	/* A class implementation comment can go here. */

	/* classVar1 documentation comment */
	public static int classVar1;
	
	/**
	 * classVar2 documentation comment that happens to be more than one line long
	 */
	private static Object classVar2;
	
	/* instanceVar1 documentation comment */
	public Object instanceVar1;
	
	/* instanceVar2 documentation comment */
	protected int instanceVar2;
	
	/* instanceVar3 documentation comment */
	private Object[] instanceVar3;
	
	/**
	 * …constructor Blah documentation comment…
	 */
	public Blah() {
		// …implementation goes here…
	}

	/**
	 * …method doSomething documentation comment…
	 */
	public void doSomething() {
		// …implementation goes here…
	}

	/**
	 * …method doSomethingElse documentation comment…
	 * @param someParam description
	 */
	public void doSomethingElse(Object someParam) {
		// …implementation goes here…
	}
}