7 - 语句

7.1 简单语句

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

    argv++;         // 正确
    argc--;         // 正确  
    argv++; argc--; // 避免!

7.2 复合语句

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

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

7.3 return 语句

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

    return;

    return myDisk.size();

    return (size ? size : defaultSize);

7.4 if, if-else, if else-if else 语句

if-else语句应该是以下形式:

    if (condition) {
        statements;
    }

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

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

注意: if语句通常使用{}。避免下面容易出错的形式:

    if (condition) // 避免！这省略了括号{ }！
        statement;

7.5 for 语句

for 语句应该是如下形式:

    for (initialization; condition; update) {
        statements;
    }

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

    for (initialization; condition; update);

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

7.6 while 语句

while 语句应该是如下形式:

    while (condition) {
        statements;
    }

空的 while 语句应该是如下形式:

    while (condition);

7.7 do-while 语句

do-while 语句应该是如下形式:

    do {
        statements;
    } while (condition);

7.8 switch 语句

switch 语句应该是如下形式:

    switch (condition) {
    case ABC:
        statements;
        /* falls through */
    case DEF:
        statements;
        break;
    case XYZ:
        statements;
        break;
    default:
        statements;
        break;
    }

每当一个 case 顺着往下执行时(因为没有 break 语句)，通常应在 break 语句的位置添加注释。上面的示例代码中就包含注释 /* falls through */。

Every switch statement should include a default case. The break in the default case is redundant, but it prevents a fall-through error if later another case is added.

7.9 try-catch 语句

try-catch 语句应该是如下格式:

    try {
        statements;
    } catch (ExceptionClass e) {
         statements;
    }

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

    try {
        statements;
    } catch (ExceptionClass e) {
        statements;
    } finally {
        statements;
    }

8 - 空白

8.1 空行

空行将逻辑相关的代码段分隔开，以提高可读性。

下列情况应该总是使用两个空行：

一个源文件的两个片段之间
类声明和接口声明之间

下列情况应该总是使用一个空行：

两个方法之间
方法内的局部变量和方法的第一条语句之间
块注释（参见"5.1.1 节"）或单行注释（参见"5.1.2 节"）之前
一个方法内的两个逻辑段之间，用以提高可读性

8.2 空格

下列情况应该使用空格：

一个紧跟着括号的关键字应该被空格分开，例如：

    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 - 命名规范

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

标识符类型 | 命名规则 | 示例
----------|---------|---------
包(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 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 - 编程惯例

10.1 提供对实例以及类变量的访问

如果没有充分理由，不要设置实例或者类变量为 public。通常实例变量无需显式的set(设置)和gotten(获取)，通常这作为方法调用的side effect (边缘效应)而产生。

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

10.2 引用类变量和类方法

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

    classMethod();             // OK
    AClass.classMethod();      // OK
    anObject.classMethod();    // 避免!

10.3 常量

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

10.4 变量赋值

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

    fooBar.fChar = barFoo.lchar = 'c'; // 避免!

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

    if (c++ = d++) {        // 避免! (Java 不允许)
        ...
    }

应写成

    if ((c++ = d++) != 0) {
        ...
    }

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

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

应该写成

    a = b + c;
    d = a + r;

10.5 其它惯例

10.5.1 圆括号

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

    if (a == b && c == d)     // 避免!
    if ((a == b) && (c == d)) // 正确

10.5.2 返回值

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

    if (booleanExpression) {
        return true;
    } else {
        return false;
    }

应该用下面代替

    return booleanExpression;

同理,

    if (condition) {
        return x;
    }
    return y;

应该写为

    return (condition ? x : y);

10.5.3 条件运算符`?`前的表达式

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

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

10.5.4 特殊注解

使用 XXX 标识处代码虽然实现了功能，但是实现的方法有待商榷，希望将来能改进。使用 FIXME 标识处代码需要修正，甚至代码是错误的，不能工作，需要修复。

11 - 代码示例

11.1 Java 源文件示例

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

    /*
     * @(#)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...
        }
    }

4. Java 编码规范(2) <编程 编程学习 IT料理>