JAVA代码规范笔记（上） - JAVA

文件组织

1、超过2000行代码的源文件将会比较难以阅读，应该避免。

2、每个Java源文件都包含单一的公共类或接口。如果私有类和接口与一个公共类有联系，可以把它们与这个公共类放在同一个源文件中。公共类必须是文件中的第一个类或接口。

3、JAVA源文件内容应该遵循以下顺序：

开头注释包声明和引入语句，如：

import java.applet.Applet;
import java.awt.*;
import java.net.*;

/*
 *Classname
 *
 *Version info
 *
 *Copyright notice
 */

5、包声明和引入语句大多数Java源文件的第一条非注释语句都是包声明语句，接着是引入语句。如下：

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

6、类和接口声明下表描述了类和接口声明的各个部分，以及它们出现的顺序。

	类/接口声明的各部分	备注
1	类/接口的文档注释	该注释所需包含的信息可以参见下面的文档注释
2	类/接口的声明
3	类/接口的实现注释(/.../),如果有必要的话	该注释应该包含所有与类或接口有关的信息，而这些信息又不适合作文档注释。
4	类（静态）变量	首先是类的公有(public)变量，然后是保护(protected)变量，之后是私有(private)变量。
5	实例变量	首先是公有的(public)，接着是保护的(protected)，之后是私有的(private)。
6	构造方法
7	方法	这些方法应该按功能，而非作用域或访问权限来分组。例如，一个私有的类方法可以在两个公有的实例方法之间，其目的是为了更利于代码的阅读与理解。

缩进
7、通常4个空格被作为缩进的一个单位。缩进使用的具体结构（是空格还是制表符）并无指明。一个制表符相当于8个空格（而非4个）。 8、行长度。避免一行代码超过80字符。因为它们在许多终端或工具都无法被很好的处理。注意：在文档中的例子行长度应该更短，一般不超过70字符。 9、换行当一条语句无法在一行写完，可以根据下面的一般原则来断句：在一个逗号后断开在一个操作符前断开高级别的断开优先于低级别的断开新的一行应该与上一句同一级别表达式的开头处对齐如果以上的规则导致代码混乱，或使代码都堆挤在右边，可以代之以8个空格的缩进。下面是断开方法调用的一些例子：

function(longExpression1, longExpression2, longExpression3,
         longExpression4, longExpression5);
var = function1(longExpression1,
                function2(longExpression2,
                          longExpression3));

下面两个例子是断开算术表达式的例子。第一个更好一点，因为断开处是在括号表达式外面，它是个较高级别的断开。

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

下面是两个方法声明的缩进例子。第一个例子是常规情况。而第二个例子，如果使用常规的缩进方式，它会使第二行和第三行的代码太过于偏右，所以以缩进8个空格的方式代替。

//常规缩进
someMethod(int anArg, Object anotherArg, String yetAnotherArg,
           Object andStillAnother) {
    ...
}
//以8个空格来代替，以避免缩进太严重
private static synchronized horkingLongMethodName(int anArg,
        Object anotherArg, String yetAnotherArg,
        Object andStillAnother) {
    ...
}

if语句的换行通常应该使用8个空格的规则，因为常规的缩进（使用4个空格）会使语句体比较难以阅读。例如：

//请勿使用这种缩进
if ((condition1 && condition2)
    || (condition3 && condition4)
    ||!(condition5 && condition6)) { //BAD WRAPS
    doSomethingAboutIt(); //MAKE THIS LINE EASY TO MISS
}
//使用这种缩进来代替
if ((condition1 && condition2)
        || (condition3 && condition4)
        ||!(condition5 && condition6)) {
    doSomethingAboutIt();
}
//或这种缩进
if ((condition1 && condition2) || (condition3 && condition4)
        ||!(condition5 && condition6)) {
    doSomethingAboutIt();
}

下面是三种格式化三目表达式的可行方法。

alpha = (aLongBooleanExpression)   beta : gamma;
alpha = (aLongBooleanExpression)   beta
                                 : gamma;
alpha = (aLongBooleanExpression)
          beta
        : gamma;

注释 10、Java程序有两类注释：实现注释和文档注释。实现注释就是在那些C++代码中见到的，使用/*...*/和//来限定的注释。文档注释是Java独有的，使用/**...*/来限定的注释。文档注释可以通过javadoc工具来提取成HTML文件。实现注释是用来解释代码或详细说明实现的。文档注释通过实现自由的角度，来描述代码的使用说明，它被那些没必要有源代码在手上的程序员阅读。
注释通常用来给出代码的概述，和提供从代码本身不易得到的附加信息。注释应该只包含与阅读理解程序相关的信息。例如，相应的包如何被创建，或者它位于哪个目录，这样的信息就不应该包含在注释中。注意：太频繁的注释有时也可以反映出代码质量欠佳。当你感觉不得不加上一个注释时，考虑一下重写代码并它更清晰。注释不应该被封闭在一个用星号或其他字符画成的大框里。注释永远都不应该包含像制表符或退格符这样的特殊字符。
11、实现注释程序可以有四种风格的实现注释：块注释，单行注释，尾端注释和行末注释。
12、块注释块注释通常用于提供文件、方法、数据结构和算法的描述。块注释应当用在每个文件的开头和每个方法的前面。它们也可以用在其他地方，例如方法内部。在函数或方法内部的注释，应该和他们描述的代码有同样级别的缩进。块注释前面应该有一个空行，来将它与其他代码分离开。块注释除了第一行之外，每一行都以一个星号“*”开头。

/*
 * Here is a bl

JAVA代码规范笔记（上）(一)