java开发用allman风格_Java 程序代码书写风格及一些简单的注意事项

方法、变量与常量的命名规则

关于包、类及接口的命名规则，在上面的章节中已经讲解过，在此就不再赘述了，本节讲解在Java程序设计中，有关方法、变量与常量的命名规则相关的知识。

1.10.1  方法的命名规则

方法一般来说都是动词，第一个字母应该小写，在多个单词混合的情况下，第一个单词后的所有单词的第一个字母大写，其余字母小写，例如下面的代码：

run();

runFast();

getBackground();

在方法的声明部分，通常要提供对方法功能的描述，以及方法中返回值与参数的说明，例如下面的代码：

/**

* 显示系统信息方法

* @param message 系统信息参数

* @return message 返回系统信息

*/

public String showMessage (String message) {

…

// statements;

…

return message;

}

如果该方法在软件产品的不断升级中已经不被建议使用了，可以通过在方法声明注释部分添加关键字@deprecated实现。

1.10.2  变量的命名规则

变量的命名规则是，除了变量(variable)，所有对象的实例(instance)，类(class)与类的常量(constant)的第一个字母应该小写，在多个单词混合的情况下第一个单词后的所有单词的第一个字母大写，其余字母小写的规则之外。变量的第一个字母即使系统允许，也不要为_或者$。变量名字因该紧凑而有意义。变量的名字应该是易记忆、易于理解的，即使间隔较长的时间也可以依其名而知其意。另外单字符的变量名应该尽量避免，除非临时变量，例如，一些整数单字符临时变量：i,j,k,m,n等以及单字符变量：c,d,e等，如下所示的代码：

int  i;

char  c;

float imageWidth;

1.10.3  常量的命名规则

Java中的常量一般采用大写字母单词命名，单词与单词之间用下划线(_)加以分割，这符合ANSI的常量命名规则，如下所示的代码：

static final int MIN_WIDTH = 14;

static final int MAX_WIDTH = 1000;

static final int GET_THE_MEMORY = 128;

&注意  关于关键字static与final的用法，我们将在下面章节做详细的讨论。

上面讨论了Java语言中的代码编写风格及相关格式与书写规则，下面做一个简单Java程序设计的实践，从中掌握所学过的知识。

1.11  Java编程实践

通过四个方面来讲解Java程序设计风格与格式规则，这是编写大师级代码的基础。

1.11.1  访问实例与类中变量的规则

一般情况下，都不要将类中的变量声明为公共类型(public)，除非设计要求如此，如果变量不是公共类型的，这样只能通过public类型方法去访问相关变量，如：getXX()方法等。如果你创建的类中没有任何行为方法，此时你不得不将这个类中的变量声明为公共(public)类型，以供外界访问。

1.11.2  引用类中的静态变量与方法的规则

当你试图在你的代码中引用类的静态方法或静态成员变量时，不要通过该类的实例对象引用它们，尽管这样是允许的。你应该通过类来引用它们，如下所示的代码：

public static classMethod();

MyClass.classMethod();      // 正确

myObject.classMethod();    // 不正确(应该避免)

1.11.3  变量赋值规则

尽量避免在一个单行语句中将一个变量赋多个值，这样将使代码变得艰涩、难懂，例如下面的代码：

userName = user1.name = 'jerry lin'; // 这种赋值方式应尽量避免

尽量避免对一元表达式赋值，例如下面的代码在Java中是绝对不允许的：

if (i++ = m++) {

...

}

当然可以修改为下面的方式，便可以逃避语法错误，不过这是不被推荐使用的：

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

...

}

尽量避免嵌套赋值，这样会浪费编译器较多的时间，例如下面的代码：

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

上面的赋值方式应修改为下面的方式：

a = b + c;

d = a + r;

1.11.4  综合规则

1．括号规则

应尽量使用括号()来界定表达式的结合顺序，避免由于运算符优先级的问题而导致非主观意图错误，即使你对运算符优先级比较了解而且代码看起来也比较清晰，但是其他程序员看这段代码未必像你一样清楚，例如下面的代码：

if (i == j && m == n)     // 应尽量避免

if ((i == j) && (m == n)) // 正确

2．返回值规则

应尽量使程序结构与你的意图匹配，例如：

if (isTrue) {

return true;

} else {

return false;

}

上面的程序有些“受累不讨好”的感觉，应该修改为：

return isTrue;

相似的有，

if (condition) {

return x;

}

return y;

应该修改为：

return (condition ? x : y);

3．特殊注释规则

你可以在程序中通过一些特殊注释来表示你的伪代码，例如，用EXECUTE表示该代码有问题但是可执行，用FIXME表示代码有问题切不可执行，例如下面的代码：

if (isTrue) {

// EXECUTE

int i = 0;

i++;

} else {

// FIXME 因为i没有被声明

i++;

}

到此为止，关于Java程序设计的代码风格与格式规则就全部讲解完了，希望你们在自己的代码中尽量应用，开始应用可能不太习惯，但是只要坚持下去，相信你会发现采用良好代码风格进行程序设计的种种好处，并且逐渐会对它产生倾慕与依恋。

小结