惯例

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

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

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

引用类变量和类方法

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

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

常量

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

变量赋值

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

    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;

其它惯例

圆括号

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

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

返回值

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

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

应该用下面代替

    return booleanExpression;

同理

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

应该写为

    return (condition ? x : y);

条件运算符?前的表达式

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

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

特殊注解

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