《代码和注释规范.docVIP

文档编号 版 本 1.0 JAVA编程规范 代码规范 注释规范 1．引言 本文档对Java代码的编程方式、风格做了统一规范，目的是减少编程人员代码编写中的语法错误，并通过增强代码的通读性和易懂性，使得代码修改和程序维护相对简单。 本文档可用作公司新进人员的培训材料，也可用作检查代码编写质量的参考。 2．代码规范 2.1 缩进 缩进必须用 Tab 键。不允许使用 空格 键缩进。每Tab缩进4个空格长度。 2.2 页宽 页宽设置为80字符80字符 在逗号之后折行 在操作符之前折行 当表达式或语句有多层嵌套时，尽量避免或减少拆开嵌套层次 折行代码的缩进位置应对齐于前一行的同一嵌套层次 若沿用以上规则导致代码杂乱或者代码太靠右，就用2个Tab缩进代替 这里是一些方法定义和调用的折行例子： someMethod(longExpression1, longExpression2, longExpression3, longExpression4, longExpression5); var = someMethod1(longExpression1, someMethod2(longExpression2, longExpression3)); 以下是三个算术表达式的折行例子。前两个都是正确的，都避免了括弧表达式被拆开，第三种情况应当避免。 longName1 = longName2 * (longName3 + longName4 - longName5) + 4 * longname6; //正确的 longName1 = longName2 * (longName3 + longName4 - longName5) + 4 * longname6; //正确的 longName1 = longName2 * (longName3 + longName4 - longName5) + 4 * longname6; //避免的 下面是两个方法定义的缩进例子。第一个是规范的例子。第二个例子，如果沿用常规的缩进规范，第二行和第三行将会紧靠右端，左边留白太多，因此用以2个Tab字符替代缩进。 //规范的缩进 someMethod(int anArg, Object anotherArg, String yetAnotherArg, Object andStillAnother) { ... } //用2个Tab字符来避免缩进过深 private static synchronized horkingLongMethodName(int anArg, Object anotherArg, String yetAnotherArg, Object andStillAnother) { ... } 对于 if 语句的折行必须用2个Tab缩进。常规的缩进可能导致别扭的代码结构，例如： //不使用这种缩进 if ((condition1 condition2) || (condition3 condition4) ||!(condition5 condition6)) { //不正确的分行 doSomethingAboutIt(); //可能导致此行被忽略 } //支持使用这种缩进 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; 2.4 打印语句 程序调试时，打印语句（System.out.println()）必须靠齐代码页左端书写，便于整理代码时去除此调试信息。 3．注释规范 Java程序有两种注释方式：代码注释和文档注释。代码注释类似于C++中的注释，包含在/* … */之中或者在//之后。文档注释是Java所特有的doc注释，它以/**开始，到*/结束。文档注释主要是为支持JDK工具javad