java书写规范

一、目的

对于代码，首要要求是它必须正确，能够按照程序员的真实思想去运行；第二个的要求是代码必须清晰易懂，使别的程序员能够容易理解代码所进行的实际工作。在软件工程领域，源程序的风格统一标志着可维护性、可读性，是软件项目的一个重要组成部分。而目前还没有成文的编码风格文档，以致于很多时候，程序员没有一个共同的标准可以遵守，编码风格各异，程序可维护性差、可读性也很差。通过建立代码编写规范，形成开发小组编码约定，提高程序的可靠性、可读性、可修改性、可维护性、可继承性和一致性，可以保证程序代码的质量，继承软件开发成果，充分利用资源，使开发人员之间的工作成果可以共享。

本文在参考业界已有的编码风格的基础上，描述了一个基于 JBuilder 的项目风格，力求一种统一的编程风格，并从整体编码风格、代码文件风格、函数编写风格、变量风格、注释风格等几个方面进行阐述。（这些规范并不是一定要绝对遵守，但是一定要让程序有良好的可读性）

二、整体编码风格

1、缩进

缩进建议以4个空格为单位。建议在 Tools/Editor Options 中设置 Editor 页面的Block ident为4，Tab Size 为8。预处理语句、全局数据、标题、附加说明、函数说明、标号等均顶格书写。语句块的"{"、"}"配对对齐，并与其前一行对齐，语句块类的语句缩进建议每个"{"、"}"单独占一行，便于匹对。JBuilder 中的默认方式是开始的"{"不是单独一行，建议更改成上述格式（在 Project/Default Project Properties 中设置 Code Style 中选择 Braces 为 Next line）。

2、空格

原则上变量、类、常量数据和函数在其类型，修饰名称之间适当空格并据情况对齐。关键字原则上空一格，如：if ( ... ) 等。运算符的空格规定如下："::"、"->"、"["、"]"、"++"、"--"、"~"、"!"、"+"、"-"（指正负号）、"&"（引用）等几个运算符两边不加空格（其中单目运算符系指与操作数相连的一边），其它运算符（包括大多数二目运算符和三目运算符"?:"两边均加一空格，在作函数定义时还可据情况多空或不空格来对齐，但在函数实现时可以不用。","运算符只在其后空一格，需对齐时也可不空或多空格。不论是否有括号，对语句行后加的注释应用适当空格与语句隔开并尽可能对齐。个人认为此项可以依照个人习惯决定遵循与否。

3、对齐

原则上关系密切的行应对齐，对齐包括类型、修饰、名称、参数等各部分对齐。另每一行的长度不应超过屏幕太多，必要时适当换行，换行时尽可能在","处或运算符处，换行后最好以运算符打头，并且以下各行均以该语句首行缩进，但该语句仍以首行的缩进为准，即如其下一行为“{”应与首行对齐。

变量定义最好通过添加空格形成对齐，同一类型的变量最好放在一起。如下例所示：

int        Value;
int        Result;
int        Length;

Object     currentEntry;

个人认为此项可以依照个人习惯决定遵循与否。

4、空行

不得存在无规则的空行，比如说连续十个空行。程序文件结构各部分之间空两行，若不必要也可只空一行，各函数实现之间一般空两行，由于每个函数还要有函数说明注释，故通常只需空一行或不空，但对于没有函数说明的情况至少应再空一行。对自己写的函数，建议也加上“//------”做分隔。函数内部数据与代码之间应空至少一行，代码中适当处应以空行空开，建议在代码中出现变量声明时，在其前空一行。类中四个“p”之间至少空一行，在其中的数据与函数之间也应空行。

5、注释

注释是软件可读性的具体体现。程序注释量一般占程序编码量的20%，软件工程要求不少于20%。程序注释不能用抽象的语言，类似于"处理"、"循环"这样的计算机抽象语言，要精确表达出程序的处理说明。例如："计算净需求"、"计算第一道工序的加工工时"等。避免每行程序都使用注释，可以在一段程序的前面加一段注释，具有明确的处理逻辑。

注释必不可少，但也不应过多，不要被动的为写注释而写注释。以下是四种必要的注释：

A. 标题、附加说明。

B. 函数、类等的说明。对几乎每个函数都应有适当的说明，通常加在函数实现之前，在没有函数实现部分的情况下则加在函数原型前，其内容主要是函数的功能、目的、算法等说明，参数说明、返回值说明等，必要时还要有一些如特别的软硬件要求等说明。公用函数、公用类的声明必须由注解说明其使用方法和设计思路，当然选择恰当的命名格式能够帮助你把事情解释得更清楚。

C. 在代码不明晰或不可移植处必须有一定的说明。

D. 及少量的其它注释，如自定义变量的注释、代码书写时间等。

注释有块注释和行注释两种，分别是指："/**/"和"//"建议对A用块注释，D用行注释，B、C则视情况而定，但应统一，至少在一个单元中B类注释形式应统一。具体对不同文件、结构的注释会在后面详细说明。

6、代码长度

对于每一个函数建议尽可能控制其代码长度为53行左右，超过53行的代码要重新考虑将其拆分为两个或两个以上的函数。函数拆分规则应该一不破坏原有算法为基础，同时拆分出来的部分应该是可以重复利用的。对于在多个模块或者窗体中都要用到的重复性代码，完全可以将起独立成为一个具备公用性质的函数，放置于一个公用模块中。

7、页宽

页宽应该设置为80字符。源代码一般不会超过这个宽度, 并导致无法完整显示, 但这一设置也可以灵活调整. 在任何情况下, 超长的语句应该在一个逗号或者一个操作符后折行. 一条语句折行后, 应该比原来的语句再缩进2个字符.

8、行数

一般的集成编程环境下，每屏大概只能显示不超过50行的程序，所以这个函数大概要5-6屏显示，在某些环境下要8屏左右才能显示完。这样一来，无论是读程序还是修改程序，都会有困难。因此建议把完成比较独立功能的程序块抽出，单独成为一个函数。把完成相同或相近功能的程序块抽出，独立为一个子函数。可以发现，越是上层的函数越简单，就是调用几个子函数，越是底层的函数完成的越是具体的工作。这是好程序的一个标志。这样，我们就可以在较上层函数里容易控制整个程序的逻辑，而在底层的函数里专注于某方面的功能的实现了。

三、代码文件风格

所有的 Java(*.java) 文件都必须遵守如下的样式规则：

. 文件生成

对于规范的 JAVA 派生类，尽量用 JBuilder 的 Object Gallery 工具来生成文件格式，避免用手工制作的头文件/实现文件。

. package/import

package 行要在 import 行之前，import 中标准的包名要在本地的包名之前，而且按照字母顺序排列。如果 import 行中包含了同一个包中的不同子目录，则应该用 * 来处理。
package hotlava.net.stats;
import java.io.*;
import java.util.Observable;
import hotlava.util.Application; 

这里 java.io.* 使用来代替InputStream and OutputStream 的。

. 文件头部注释

文件头部注释主要是表明该文件的一些信息，是程序的总体说明，可以增强程序的可读性和可维护性。文件头部注释一般位于 package/imports 语句之后，Class 描述之前。要求至少写出文件名、创建者、创建时间和内容描述。JBuilder 的 Object Gallery 工具生成的代码中会在类、工程文件中等自动添加注释，我们也要添加一些注释，其格式应该尽量约束如下：

/**
* Title: 确定鼠标位置类
* Description: 确定鼠标当前在哪个作业栏位中并返回作业号
* @Copyright: Copyright (c) 2002
* @Company: HIT
* @author: rivershan
* @version: 1.0
* @time: 2002.10.30
*/

. Class

接下来的是类的注释，一般是用来解释类的。

/**
* A class representing a set of packet and byte counters
* It is observable to allow it to be watched, but only
* reports changes when the current set is complete
*/ 

接下来是类定义，包含了在不同的行的 extends 和 implements

public class CounterSet
extends Observable
implements Cloneable

.Class Fields

接下来是类的成员变量：

/**
* Packet counters
*/

protected int[] packets;

public 的成员变量必须生成文档（JavaDoc）。proceted、private和 package 定义的成员变量如果名字含义明确的话，可以没有注释。

. 存取方法

接下来是类变量的存取的方法。它只是简单的用来将类的变量赋值获取值的话，可以简单的写在一行上。（个人认为尽量分行写）

/**
* Get the counters
* @return an array containing the statistical data. This array has been
* freshly allocated and can be modified by the caller.
*/

public int[] getPackets() 
{
return copyArray(packets, offset); 
}

public int[] getBytes() 
{ 
return copyArray(bytes, offset); 
}

public int[] getPackets() 
{ 
return packets; 
}

public void setPackets(int[] packets) 
{ 
this.packets = packets; 
}

其它的方法不要写在一行上

. 构造函数

接下来是构造函数，它应该用递增的方式写（比如：参数多的写在后面）。

访问类型("public","private" 等.)和任何"static","final"或"synchronized"应该在一行中，并且方法和参数另写一行，这样可以使方法和参数更易读。

public
CounterSet(int size)
{
   this.size = size;
}

. 克隆方法

如果这个类是可以被克隆的，那么下一步就是 clone 方法：

public
Object clone()
{
try 
   {
     CounterSet obj = (CounterSet)super.clone();
     obj.packets = (int[])packets.clone();
     obj.size = size;
     return obj;
   } 
   catch(CloneNotSupportedException e) 
   {
    throw new InternalError("Unexpected CloneNotSUpportedException: " 
          + e.getMessage());
   }
}

. 类方法

下面开始写类的方法：

/**
* Set the packet counters
* (such as when restoring from a database)
*/
protected final
void setArray(int[] r1, int[] r2, int[] r3, int[] r4)
throws IllegalArgumentException
{
//
   // Ensure the arrays are of equal size
   //
   if (r1.length != r2.length || r1.length != r3.length || r1.length != r4.length)
throw new IllegalArgumentException("Arrays must be of the same size");
   System.arraycopy(r1, 0, r3, 0, r1.length);
   System.arraycopy(r2, 0, r4, 0, r1.length);
}

. toString 方法

无论如何，每一个类都应该定义 toString 方法：

public
String toString()
{
String retval = "CounterSet: ";
    for (int i = 0; i < data.length(); i++) 
    {
       retval += data.bytes.toString();
       retval += data.packets.toString();
    }
    return retval;
}

. main 方法

如果main(String[]) 方法已经定义了, 那么它应该写在类的底部.

四、函数编写风格

. 函数的命名

通常，函数的命名也是以能表达函数的动作意义为原则的，一般是由动词打头，然后跟上表示动作对象的名词，各单词的首字母应该大写。另外，还有一些函数命名的通用规则。如取数，则用Get打头，然后跟上要取的对象的名字；设置数，则用Set打头，然后跟上要设的对象的名字；而对象中为了响应消息进行动作的函数，可以命名为On打头，然后是相应的消息的名称；进行主动动作的函数，可以命名为Do打头，然后是相应的动作名称。类似的规则还有很多，需要程序员多读优秀的程序，逐渐积累经验，才能作出好的函数命名。

. 函数注释

系统自动生成的函数，如鼠标动作响应函数等，不必太多的注释和解释；

对于自行编写的函数，若是系统关键函数，则必须在函数实现部分的上方标明该函数的信息，格式如下：

/**
* 函数名：
* 编写者：
* 参考资料：
* 功 能：
* 输入参数：
* 输出参数：
* 备 注：
*/

希望尽量遵循以上格式。

五、符号风格

. 总体要求

对于各种符号的定义，都有一个共通点，就是应该使用有实际意义的英文单词或英文单词的缩写，不要使用简单但没有意义的字串，尽可能不使用阿拉伯数字，更切忌使用中文拼音的首字母。如这样的名称是不提倡的：Value1,Value2,Value3,Value4 …。

例如：
file(文件),code(编号),data(数据),pagepoint(页面指针), faxcode(传真号) ,address(地址),bank(开户银行),……

. 变量名称

a. 变量名前缀的约定

变量类型    前缀   示例
integer     int    intCount
byte        byt    bytMove
short       sht    shtResult
long        lng    lngTotal
float       flt    fltAverage
double      dbl    dblTolerangce
boolean     bln    blnIsover
Char        chr    chrInput 
Array       arr    arrData

变量名一般要有一定的表达义,变量名中的每一个单词的第一个字母都要大写出（除去第一个单词外）

b. 描述性变量名和过程名：

变量名或过程名的主体使用大小写混合格式并且尽量完整地描述其目的，另外过程名应以动词开始如：InitNameArray ,CloseDialog

. 对象名的约定：

对象名的前缀约定：

对象类型    前缀
Button      btn
Canvas      cvs
CheckBox    chk
Image       img
Label       lbl
List        lst
Choice      chc
Dialog      dlg
Event       evt
Frame       frm
Menu        menu
Panel       pnl
TextArea    txa
TextField   txf

. Package 的命名

Package 的名字应该都是由一个小写单词组成。

. Class 的命名

Class 的名字必须由一个或数个能表达该类的意思的大写字母开头而其它字母都小写的单词或缩写组成，这样能使这个 Class 的名称能更容易被理解。

. Class 变量的命名

变量的名字必须用一个小写字母开头。后面的单词用大写字母开头。对于类的成员变量，在对其标识符命名时，要加上代表member（成员）的前缀m_。例如一个标识符为m_dwFlag，则它表示的变量是一个类型为双字的成员变量，它是代表一个标志。

. Static Final 变量的命名

Static Final 变量的名字应该都大写，并且指出完整含义。

. 参数的命名

参数的名字必须和变量的命名规范一致。

. 数组的命名

数组应该总是用下面的方式来命名：
byte[] buffer; 

而不是： 
byte buffer[];

. 方法的参数

使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字：

SetCounter(int size)
{
this.size = size;
}

. 神秘的数

首先要说什么是神秘的数。我们在程序里经常会用到一些量，它是有特定的含义的。例如，现在我们写一个薪金统计程序，公司员工有50人，我们在程序里就会用50这个数去进行各种各样的运算。在这里，50就是"神秘的数"。为什么称它为神秘呢？因为别的程序员在程序里看到50这个数，不知道它的含义，只能靠猜了。

在程序里出现"神秘的数"会降低程序的可读性，应该尽量避免。避免的方法是把神秘的数定义为一个常量。注意这个常量的命名应该能表达该数的意义，并且应该全部大写，以与对应于变量的标识符区别开来。例如上面50这个数，我们可以定义为一个名为NUMOFEMPLOYEES的常量来代替。这样，别的程序员在读程序的时候就可以容易理解了。

Java语言编码规范 
原文出处http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html 
2 文件名(File Names) 
这部分列出了常用的文件名及其后缀。 
2.1 文件后缀(File Suffixes) 
Java程序使用下列文件后缀： 
文件类别 文件后缀 
Java源文件 .java 
Java字节码文件 .class 
2.2 常用文件名(Common File Names) 
常用的文件名包括： 
文件名 用途 
GNUmakefile makefiles的首选文件名。我们采用gnumake来创建（build）软件。 
README 概述特定目录下所含内容的文件的首选文件名 
3 文件组织(File Organization) 
一个文件由被空行分割而成的段落以及标识每个段落的可选注释共同组成。超过2000行的程序难以阅读，应该尽量避免。"Java源文件范例"提供了一个布局合理的Java程序范例。 
3.1 Java源文件(Java Source Files) 
每个Java源文件都包含一个单一的公共类或接口。若私有类和接口与一个公共类相关联，可以将它们和公共类放入同一个源文件。公共类必须是这个文件中的第一个类或接口。

Java源文件还遵循以下规则： 
- 开头注释（参见"开头注释"） 
- 包和引入语句（参见"包和引入语句"） 
- 类和接口声明（参见"类和接口声明"） 
3.1.1 开头注释(Beginning Comments) 
所有的源文件都应该在开头有一个C语言风格的注释，其中列出类名、版本信息、日期和版权声明： 
/* 
* Classname 
* 
* Version information 
* 
* Date 
* 
* Copyright notice 
*/

3.1.2 包和引入语句(Package and Import Statements) 
在多数Java源文件中，第一个非注释行是包语句。在它之后可以跟引入语句。例如： 
package java.awt;

import java.awt.peer.CanvasPeer;

3.1.3 类和接口声明(Class and Interface Declarations) 
下表描述了类和接口声明的各个部分以及它们出现的先后次序。参见"Java源文件范例"中一个包含注释的例子。 
类/接口声明的各部分 注解 
1 类/接口文档注释(/**……*/) 该注释中所需包含的信息，参见"文档注释" 
2 类或接口的声明 
3 类/接口实现的注释(/*……*/)如果有必要的话 该注释应包含任何有关整个类或接口的信息，而这些信息又不适合作为类/接口文档注释。 
4 类的(静态)变量 首先是类的公共变量，随后是保护变量，再后是包一级别的变量(没有访问修饰符，access modifier)，最后是私有变量。 
5 实例变量 首先是公共级别的，随后是保护级别的，再后是包一级别的(没有访问修饰符)，最后是私有级别的。 
6 构造器 
7 方法 这些方法应该按功能，而非作用域或访问权限，分组。例如，一个私有的类方法可以置于两个公有的实例方法之间。其目的是为了更便于阅读和理解代码。 
4 缩进排版(Indentation) 
4个空格常被作为缩进排版的一个单位。缩进的确切解释并未详细指定(空格 vs. 制表符)。一个制表符等于8个空格(而非4个)。 
4.1 行长度(Line Length) 
尽量避免一行的长度超过80个字符，因为很多终端和工具不能很好处理之。 
注意：用于文档中的例子应该使用更短的行长，长度一般不超过70个字符。 
4.2 换行(Wrapping Lines) 
当一个表达式无法容纳在一行内时，可以依据如下一般规则断开之： 
- 在一个逗号后面断开 
- 在一个操作符前面断开 
- 宁可选择较高级别(higher-level)的断开，而非较低级别(lower-level)的断开 
- 新的一行应该与上一行同一级别表达式的开头处对齐 
- 如果以上规则导致你的代码混乱或者使你的代码都堆挤在右边，那就代之以缩进8个空格。 
以下是断开方法调用的一些例子： 
someMethod(longExpression1, longExpression2, longExpression3, 
longExpression4, longExpression5);

var = someMethod1(longExpression1, 
someMethod2(longExpression2, 
longExpression3));

以下是两个断开算术表达式的例子。前者更好，因为断开处位于括号表达式的外边，这是个较高级别的断开。 
longName1 = longName2 * (longName3 + longName4 - longName5) 
+ 4 * longname6; //PREFFER

longName1 = longName2 * (longName3 + longName4 
- longName5) + 4 * longname6; //AVOID

以下是两个缩进方法声明的例子。前者是常规情形。后者若使用常规的缩进方式将会使第二行和第三行移得很靠右，所以代之以缩进8个空格 
//CONVENTIONAL INDENTATION 
someMethod(int anArg, Object anotherArg, String yetAnotherArg, 
Object andStillAnother) { 
... 
}

//INDENT 8 SPACES TO AVOID VERY DEEP INDENTS 
private static synchronized horkingLongMethodName(int anArg, 
Object anotherArg, String yetAnotherArg, 
Object andStillAnother) { 
... 
}

if语句的换行通常使用8个空格的规则，因为常规缩进(4个空格)会使语句体看起来比较费劲。比如： 
//DON’T USE THIS INDENTATION 
if ((condition1 && condition2) 
|| (condition3 && condition4) 
||!(condition5 && condition6)) { //BAD WRAPS 
doSomethingAboutIt(); //MAKE THIS LINE EASY TO MISS 
}

//USE THIS INDENTATION INSTEAD 
if ((condition1 && condition2) 
|| (condition3 && condition4) 
||!(condition5 && condition6)) { 
doSomethingAboutIt(); 
}

//OR USE THIS 
if ((condition1 && condition2) || (condition3 && condition4) 
||!(condition5 && condition6)) { 
doSomethingAboutIt(); 
}


这里有三种可行的方法用于处理三元运算表达式： 
alpha = (aLongBooleanExpression) ? beta : gamma;

alpha = (aLongBooleanExpression) ? beta 
: gamma;

alpha = (aLongBooleanExpression) 
? beta 
: gamma; 
5 注释(Comments)

Java程序有两类注释：实现注释(implementation comments)和文档注释(document comments)。实现注释是那些在C++中见过的，使用/*...*/和//界定的注释。文档注释(被称为"doc comments")是Java独有的，并由/**...*/界定。文档注释可以通过javadoc工具转换成HTML文件。

实现注释用以注释代码或者实现细节。文档注释从实现自由(implementation-free)的角度描述代码的规范。它可以被那些手头没有源码的开发人员读懂。

注释应被用来给出代码的总括，并提供代码自身没有提供的附加信息。注释应该仅包含与阅读和理解程序有关的信息。例如，相应的包如何被建立或位于哪个目录下之类的信息不应包括在注释中。

在注释里，对设计决策中重要的或者不是显而易见的地方进行说明是可以的，但应避免提供代码中己清晰表达出来的重复信息。多余的的注释很容易过时。通常应避免那些代码更新就可能过时的注释。

注意：频繁的注释有时反映出代码的低质量。当你觉得被迫要加注释的时候，考虑一下重写代码使其更清晰。

注释不应写在用星号或其他字符画出来的大框里。注释不应包括诸如制表符和回退符之类的特殊字符。

5.1 实现注释的格式(Implementation Comment Formats)

程序可以有4种实现注释的风格：块(block)、单行(single-line)、尾端(trailing)和行末(end-of-line)。

5.1.1 块注释(Block Comments)

块注释通常用于提供对文件，方法，数据结构和算法的描述。块注释被置于每个文件的开始处以及每个方法之前。它们也可以被用于其他地方，比如方法内部。在功能和方法内部的块注释应该和它们所描述的代码具有一样的缩进格式。

块注释之首应该有一个空行，用于把块注释和代码分割开来，比如：

/* 
* Here is a block comment. 
*/

块注释可以以/*-开头，这样indent(1)就可以将之识别为一个代码块的开始，而不会重排它。

/*- 
* Here is a block comment with some very special 
* formatting that I want indent(1) to ignore. 
* 
* one 
* two 
* three 
*/

注意：如果你不使用indent(1)，就不必在代码中使用/*-，或为他人可能对你的代码运行indent(1)作让步。

参见"文档注释"

5.1.2 单行注释(Single-Line Comments)


短注释可以显示在一行内，并与其后的代码具有一样的缩进层级。如果一个注释不能在一行内写完，就该采用块注释(参见"块注释")。单行注释之前应该有一个空行。以下是一个Java代码中单行注释的例子：

if (condition) {

/* Handle the condition. */ 
... 
}

5.1.3 尾端注释(Trailing Comments)

极短的注释可以与它们所要描述的代码位于同一行，但是应该有足够的空白来分开代码和注释。若有多个短注释出现于大段代码中，它们应该具有相同的缩进。

以下是一个Java代码中尾端注释的例子：

if (a == 2) { 
return TRUE; /* special case */ 
} else { 
return isPrime(a); /* works only for odd a */ 
}

5.1.4 行末注释(End-Of-Line Comments)

注释界定符"//"，可以注释掉整行或者一行中的一部分。它一般不用于连续多行的注释文本；然而，它可以用来注释掉连续多行的代码段。以下是所有三种风格的例子：

if (foo > 1) {

// Do a double-flip. 
... 
} 
else { 
return false; // Explain why here. 
}

//if (bar > 1) { 
// 
// // Do a triple-flip. 
// ... 
//} 
//else { 
// return false; 
//}

5.2 文档注释(Documentation Comments)

注意：此处描述的注释格式之范例，参见"Java源文件范例"

若想了解更多，参见"How to Write Doc Comments for Javadoc"，其中包含了有关文档注释标记的信息(@return, @param, @see)：

http://java.sun.com/javadoc/writingdoccomments/index.html

若想了解更多有关文档注释和javadoc的详细资料，参见javadoc的主页：

http://java.sun.com/javadoc/index.html

文档注释描述Java的类、接口、构造器，方法，以及字段(field)。每个文档注释都会被置于注释定界符/**...*/之中，一个注释对应一个类、接口或成员。该注释应位于声明之前：

/** 
* The Example class provides ... 
*/ 
public class Example { ...

注意顶层(top-level)的类和接口是不缩进的，而其成员是缩进的。描述类和接口的文档注释的第一行(/**)不需缩进；随后的文档注释每行都缩进1格(使星号纵向对齐)。成员，包括构造函数在内，其文档注释的第一行缩进4格，随后每行都缩进5格。

若你想给出有关类、接口、变量或方法的信息，而这些信息又不适合写在文档中，则可使用实现块注释(见5.1.1)或紧跟在声明后面的单行注释(见5.1.2)。例如，有关一个类实现的细节，应放入紧跟在类声明后面的实现块注释中，而不是放在文档注释中。

文档注释不能放在一个方法或构造器的定义块中，因为Java会将位于文档注释之后的第一个声明与其相关联。

6 声明(Declarations)

6.1 每行声明变量的数量(Number Per Line)

推荐一行一个声明，因为这样以利于写注释。亦即，

int level; // indentation level 
int size; // size of table

要优于，
int level, size;

不要将不同类型变量的声明放在同一行，例如：

int foo, fooarray[]; //WRONG!

注意：上面的例子中，在类型和标识符之间放了一个空格，另一种被允许的替代方式是使用制表符：

int level; // indentation level 
int size; // size of table 
Object currentEntry; // currently selected table entry

6.2 初始化(Initialization)

尽量在声明局部变量的同时初始化。唯一不这么做的理由是变量的初始值依赖于某些先前发生的计算。

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 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; 
/* 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 _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; 

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源程序。接口的布局与其相似。更多信息参见"类和接口声明"以及"文挡注释"。 
/* 
* @(#)Blah.java 1.82 99/03/18 
* 
* Copyright (c) 1994-1999 Sun Microsystems, Inc. 
* 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. 
* All rights reserved. 
* 
* This software is the confidential and proprietary information of Sun 
* Microsystems, Inc. ("Confidential Information"). You shall not 
* disclose such Confidential Information and shall use it only in 
* accordance with the terms of the license agreement you entered into 
* with Sun. 
*/

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...