文件和程序规范.doc

文档编号 版 本 1.0 JAVA编程规范 文件规范 程序规范 1．引言 本文档对Java代码的编程方式、风格做了统一规范，目的是减少编程人员代码编写中的语法错误，并通过增强代码的通读性和易懂性，使得代码修改和程序维护相对简单。 本文档可用作公司新进人员的培训材料，也可用作检查代码编写质量的参考。 2．文件规范 每个Java源文件都是由数个代码片段组成，每个代码片段之间必须由空白行和可选择的注释间隔开。 每个Java源文件的代码总行数避免超过2000行。 正确的Java程序格式参考标题11的“代码例程”。 2.1 Java源文件 每个Java源文件都由一个具有公共属性的类或接口组成。当一个私有类或接口和某个公共类相关联时，可以将该私有类或接口做为公共类的内部类写在公共类的代码文件中，并且私有类或接口必须定义成公共属性，公共类必须是类文件中的第一个类（主类）。 Java源文件必须遵循以下样式规则： 文件头注释 Package和Import声明 类（Class）和接口（interface）定义 2.1.1 文件头注释 所有源文件开头必须包含有注释，内容包含类名、版本信息、文件生成日期： /* * Classname * * Version information * * Date * */ 2.1.2 Package和Import声明 作为第一行非注释行，package声明指明包含当前类文件的包名。在package声明之后，跟着import声明，引入类文件，例如： package java.awt; import java.awt.peer.CanvasPeer; 2.1.3 类和接口定义 下表描述了类和接口定义的各个部分，它们出现的先后次序必须按照表中的代码顺序，可以参考“代码例程”： 代码顺序 类和接口定义的各个部分 备注 1 类或接口的文档注释（/**...*/） 参考标题5.2的“文档注释”，规定了注释内容和格式 2 类或接口的定义语句 3 类或接口的代码说明 （/*...*/）, 可选 这里的注释内容包含任何需要对类或接口的代码做出说明，但不能放在类的文档注释部分的信息 4 类静态成员变量 首先定义公有（public）成员proceted）成员package 定义的成员private）成员public的成员变量proceted、package和 private定义的成员变量如果名字含义明确的话，可以没有注释。public）成员proceted）成员package 定义的成员private）成员public的成员变量proceted、package和 private定义的成员变量如果名字含义明确的话，可以没有注释。main(String[]) 方法已经定义了, 那么在类的底部 3.1 存取实例和类变量 若非必要，不要把实例或类变量的访问属性设置为公有。尽量通过方法存取实例变量。 一个特例是，类仅仅作为数据结构使用，没有类方法。可以直接存取类变量。 3.2 引用类的变量和方法 禁止通过对象访问类的静态变量和静态方法，应当通过类名去访问。例如： classMethod(); //正确 AClass.classMethod(); //正确 anObject.classMethod(); //错误! 3.3 常数 不允许编码中直接使用数字。除非象–1，0 和 1，这些需要在 for 循环中做为计算值的。 3.4 变量赋值 禁止在一条赋值语句里对多个变量赋值。将会造成难于理解，例如： fooBar.fChar = barFoo.lchar = ‘c’; // 错误! 禁止在和等于运算符容易混淆的地方使用赋值操作。例如： if (c++ = d++) { //错误! (Java 语言禁止) ... } 正确的写法是： if ((c++ = d++) != 0) { ... } 禁止为了改善运行效率而使用嵌入式赋值语句。实际上这是编译器的工作。例如： d = (a = b + c) + r; //错误! 正确的写法是： a = b + c; d = a + r; 3.5 其它惯例 3.5.1 圆括号 在表达式中，用括号()显式地标明运算次序是良好的习惯，可以防止在运算优先级上产生错误。实际上有很多情况自己认为代码是清晰的，但对别人而言不加括号会引起错误的理解。同时要注意，括号的使用必须匹配。 if (a == b c == d) //错误的! if ((a == b) (c == d)) //正确的 3.5.2 返回值 尽量使用固定格式的返回语句。象语句 if ( booleanExpression) { return true; } else { return false; } 应当被以下语句替