Java代码规范
????????? ...
????? }
? }
??????? ??
该规则的一个例外是for循环的索引变量
? for (int i = 0; i < maxLoops; i++) { ... }
??????? ?
避免声明的局部变量覆盖上一级声明的变量。例如，不要在内部代码块中声明相同的变量名：
? int count;
? ...
? myMethod() {
????? if (condition) {
????????? int count = 0;???? // AVOID!
????????? ...
????? }
????? ...
? }
??????? ?
6.4 类和接口的声明(Class and Interface Declarations)
当编写类和接口是，应该遵守以下格式规则：
l? 在方法名与其参数列表之前的左括号"("间不要有空格
l? 左大括号"{"位于声明语句同行的末尾
l? 右大括号"}"另起一行，与相应的声明语句对齐，除非是一个空语句，"}"应紧跟在"{"之后
l? 方法与方法之间以空行分隔
? 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)
复合语句是包含在大括号中的语句序列，形如"{ 语句 }"。例如下面各段。
l? 被括其中的语句应该较之复合语句缩进一个层次
l? 左大括号"{"应位于复合语句起始行的行尾；右大括号"}"应另起一行并与复合语句首行对齐。
l? 大括号可以被用于所有语句，包括单个语句，只要这些语句是诸如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 OMITS 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;
?????
? case DEF:
????? statements;
????? break;
?
? case XYZ:
????? statements;
????? break;
?
? default:
????? statements;
????? break;
? }
??????? ?
每当一个case顺着往下执行时(因为没有break语句)，通常应在break语句的位置添加注释。上面的示例代码中就包含注释。
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)
空行将逻辑相关的代码段分隔开，以提高可读性。
下列情况应该总是使用两个空行：
l? 一个源文件的两个片段(section)之间
l? 类声明和接口声明之间
下列情况应该总是使用一个空行：
l? 两个方法之间
l? 方法内的局部变量和方法的第一条语句之间
l? 块注释或单行注释之前
l? 一个方法内的两个逻辑段之间，用以提高可读性
不得存在无规则的空行，比如说连续十个空行。程序文件结构各部分之间空两行，若不必要也可只空一行，各函数实现之间一般空两行，由于每个函数还要有函数说明注释，故通常只需空一行或不空，但对于没有函数说明的情况至少应再空一行。对自己写的函数，建议也加上“//------”做分隔。函数内部数据与代码之间应空至少一行，代码中适当处应以空行空开，建议在代码中出现变量声明时，在其前空一行。类中四个“p”之间至少空一行，在其中的数据与函数之间也应空行。
8.2 空格(Blank Spaces)
下列情况应该使用空格：
l? 一个紧跟着括号的关键字应该被空格分开，例如：
? while (true) {
????? ...
? }
??????? ?
注意：空格不应该置于方法名与其左括号之间。这将有助于区分关键字和方法调用。
l? 空白应该位于参数列表中逗号的后面
l? 所有的二元运算符，除了"."，应该使用空格将之与操作数分开。一元操作符和操作数之间不应该加空格，比如：负号("-")、自增("++")和自减("--")。例如：
??? a += c + d;
??? a = (a + b) / (c * d);
?
??? while (d++ = s++) {
??????? n++;
??? }
printSize("size is " + foo + "\n");
?
l? for语句中的表达式应该被空格分开，例如：
??? for (expr1; expr2; expr3)
??????? ?
l? 强制转型后应该跟一个空格，例如：
??? myMethod((byte) aNum, (Object) x);
??? myMethod((int) (cp + 5), ((int) (i + 3)) + 1);
原则上变量、类、常量数据和函数在其类型，修饰名称之间适当空格并据情况对齐。关键字原则上空一格，如：if ( ... ) 等。运算符的空格规定如下："::"、"->"、"["、"]"、"++"、"--"、"~"、"!"、"+"、"-"（指正负号）、"&"（引用）等几个运算符两边不加空格（其中单目运算符系指与操作数相连的一边），其它运算符（包括大多数二目运算符和三目运算符"?:"两边均加一空格，在作函数定义时还可据情况多空或不空格来对齐，但在函数实现时可以不用。","运算符只在其后空一格，需对齐时也可不空或多空格。不论是否有括号，对语句行后加的注释应用适当空格与语句隔开并尽可能对齐。个人认为此项可以依照个人习惯决定遵循与否。
9 命名规则
命名规范使程序更易读，从而更易于理解。它们也可以提供一些有关标识符功能的信息，以助于理解代码，例如，不论它是一个常量，包，还是类。
包(Packages)
一个唯一包名的前缀总是全部小写的ASCII字母并且是一个顶级域名，通常是com，edu，gov，mil，net，org，或1981年ISO 3166标准所指定的标识国家的英文双字符代码。包名的后续部分根据不同机构各自内部的命名规范而不尽相同。这类命名规范可能以特定目录名的组成来区分部门(department)，项目(project)，机器(machine)，或注册名(login names)。
名词或名词性词组，全部小写；一般使用本公司／组织网站域名的逆序后跟具体的软件内部模块名
命名实例
com.sun.eng
com.apple.quicktime.v2
edu.cmu.cs.bovik.cheese
?
类(Classes)
类名是个一名词，采用大小写混合的方式，每个单词的首字母大写。尽量使你的类名简洁而富于描述。使用完整单词，避免缩写词(除非该缩写词被更广泛使用，像URL，HTML)
命名实例???
class Raster;
class ImageSprite;
?
接口(Interfaces) 规则同类
命名实例??
interface RasterDelegate;
?
方法(Methods)
方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。
命名实例????
run();
runFast();
getBackground();
变量(Variables)
名词或名词性词组，首字母小写，第二个及以后的单词首字母大写；不提倡使用下画线"_"和美元符"$"作为变量开头；单词间可以使用下画线分隔；变量名不宜过长但也应有意义，除非是临时使用（例如只涉及几行代码）后即丢弃的情况，不建议使用单个字母做变量名，常用的临时使用的变量名包括表示整数的i，j，k，m，n和表示字母的c以及表示异常对象的e等。
变量命名举例：
int age； int student_age； String studentName； Exception e；
常量(Constants)
名词或名词性词组，每个单词的首字母大写；单词间使用下画线分隔。
常量命名举例：int MAX_LEVEL； double Comm_Tax；
数组
Byte [] buffer;
而不是Byte buffer[];
10 编程惯例(Programming Practices)
10.1 提供对实例以及类变量的访问控制(Providing Access to Instance and Class Variables)
若没有足够理由，不要把实例或类变量声明为公有。通常，实例变量无需显式的设置(set)和获取(gotten)，通常这作为方法调用的边缘效应 (side effect)而产生。
一个具有公有实例变量的恰当例子，是类仅作为数据结构，没有行为。亦即，若你要使用一个结构(struct)而非一个类(如果java支持结构的话)，那么把类的实例变量声明为公有是合适的。
10.2 引用类变量和类方法(Referring to Class Variables and Methods)
避免用一个对象访问一个类的静态变量和方法。应该用类名替代。例如：
? classMethod();???????????? //OK
? AClass.classMethod();????? //OK
? anObject.classMethod();??? //AVOID!
??????? ?
10.3 常量(Constants)
位于for循环中作为计数器值的数字常量，除了-1,0和1之外，不应被直接写入代码。
10.4 变量赋值(Variable Assignments)
避免在一个语句中给多个变量赋相同的值。它很难读懂。例如：
? fooBar.fChar = barFoo.lchar = 'c'; // AVOID!
??????? ?
不要将赋值运算符用在容易与相等关系运算符混淆的地方。例如：
? if (c++ = d++) {??????? // AVOID! (Java disallows)
????? ...
? }
应该写成
? if ((c++ = d++) != 0) {
??? ...
? }
不要使用内嵌(embedded)赋值运算符试图提高运行时的效率，这是编译器的工作。例如：
? d = (a = b + c) + r;??????? // AVOID!
应该写成
? a = b + c;
? d = a + r;
??????? ?
10.5 其它惯例(Miscellaneous Practices)
10.5.1 圆括号(Parentheses)
一般而言，在含有多种运算符的表达式中使用圆括号来避免运算符优先级问题，是个好方法。即使运算符的优先级对你而言可能很清楚，但对其他人未必如此。你不能假设别的程序员和你一样清楚运算符的优先级。
? if (a == b && c == d)???? // AVOID!
? if ((a == b) && (c == d))? // RIGHT
??????? ?
10.5.2 返回值(Returning Values)
设法让你的程序结构符合目的。例如：
? if (booleanExpression) {
????? return true;
? } else {
????? return false;
? }
应该代之以如下方法：
? return booleanExpression;
类似地：
? if (condition) {
????? return x;
? }
? return y;
应该写做：
? return (condition ? x : y);
??????? ?
10.5.3 条件运算符"?"前的表达式(Expressions before '?' in the Conditional Operator)
如果一个包含二元运算符的表达式出现在三元运算符" ? : "的"?"之前，那么应该给表达式添上一对圆括号。例如：
? (x >= 0) ? x : -x;
??????? ?
10.5.4 特殊注释(Special Comments)
在注释中使用XXX来标识某些未实现(bogus)的但可以工作(works)的内容。用FIXME来标识某些假的和错误的内容。
11 代码范例(Code Examples)
11.1 Java源文件范例(Java Source File Example)
下面的例子，展示了如何合理布局一个包含单一公共类的Java源程序。接口的布局与其相似。
?
?
?
package java.blah;
?
import java.blah.blahdy.BlahBlah;
?
?
public class Blah extends SomeClass {
???
?
???
??? public static int classVar1;
?
???
??? private static Object classVar2;
?
???
??? public Object instanceVar1;
?
???
??? protected int instanceVar2;
?
???
??? private Object[] instanceVar3;
?
???
??? public Blah() {
??????? // ...implementation goes here...
??? }
?
???
??? public void doSomething() {
??????? // ...implementation goes here...
??? }
?
???
??? public void doSomethingElse(Object someParam) {
??????? // ...implementation goes here...
??? }
?
}
?
