Java编码规范

声明（Declaration）

1、推荐一行只声明一个变量，这样便于写注释。

2、初始化（Initialization）：尽量在声明局部变量的同时进行初始化，除非变量的初始值依赖于某些先前发生的计算。

3、只在代码块的开始处声明变量。（代码块是指任何被包含在大括号之间的代码）

4、类和接口的声明：

    1）方法名与其参数列表以前的左括号“（”之间不要有空格。

    2）左大括号“{”位于声明语句同行的末尾。

    3）右大括号“}”另起一行，与相应的声明语句对齐，除非是一个空语句，“}”应紧跟在“{”之后。

空白（White Space）

1、空行（Blank Lines）：空行将逻辑相关的代码段分隔开，以提高可读性。

    1）使用两个空行：一个源文件的两个片段（section）之间；类声明和接口声明之间。

    2）使用一个空行：两个方法之间；方法内的局部变量和方法的第一条语句之间；块注释或单行注释之前；一个方法内的两个逻辑段之间，用以提高可读性。

2、空格（Blank Spaces）

    1）一个紧跟着括号的关键字应该被空格分开，例如：while (true) {....}

    2）在参数列表中的逗号后面应该有空格。

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

    4）for语句中的表达式应该被空格分开。

    5）强制转型之后应该跟一个空格，例如：(int) i;

命名规范（Naming Convention）

命名规范使程序更易读，也可以提供一些有关标识符功能的信息，有助于理解代码。

标识符类型命名规则实例包（Packages）一个唯一包名的前缀总是全部小写的ASCII码字符，并且是一个顶级域名，通常是com, edu, gov, mil, net, org或1981年ISO 3166标准所指定的标识国家的英文双字符代码。包名的后续部分根据不同机构各自内部的命名规范而不尽相同。这类命名规范可能以特定目录名的组成来区分部门，项目，机器或注册名。 com.sun.eng 
com.apple.quicktime.v2 
edu.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 _employeeId; 
String _name; 
Customer _customer; 常量
(Constants) 类常量和 ANSI常量的声明，应该全部大写，单词间用下划线隔开。(尽量避免 ANSI常量，容易引起错误）static final int 
MIN_WIDTH = 4; 
static final int 
MAX_WIDTH = 999; 
static final int 
GET_THE_CPU = 1; 

编程惯例（Programming Practices）

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

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

2、引用类变量和类方法（Referring to Class Variables and Methods）

    1）避免用一个对象访问一个类的静态变量和方法，应该用类名替代。例如：classMethod();        //ok                AClass.classMethod();             //ok                    AnObject.classMethod();                  ////////////avoid

3、避免在一个语句中给多个变量赋相同的值。它很难读懂。例如：fooBar.fChar = barFoo.lchar = ‘c’;  // AVOID!

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

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

应该写成

    a = b + c;

    d = a + r;

注：Java编程规范摘自：sun推荐的Java编码规范.doc