代码和注释规范

《代码和注释规范》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、JAVA编程规范代码和注释规范文档编号版本1.0JAVA编程规范代码规范注释规范第8页共8页JAVA编程规范代码和注释规范1．引言本文档对Java代码的编程方式、风格做了统一规范，目的是减少编程人员代码编写中的语法错误，并通过增强代码的通读性和易懂性，使得代码修改和程序维护相对简单。本文档可用作公司新进人员的培训材料，也可用作检查代码编写质量的参考。2．代码规范2.1缩进缩进必须用Tab键。不允许使用空格键缩进。每Tab缩进4个空格长度。2.2页宽页宽设置为80字符，即每行代码不应超过80字符数。

2、注：写在文档中的例子每行的宽度应更短，一般不超过70字符。2.3折行当一个表达式或一行语句超长时(超出页宽)，必须按以下规则进行折行：l在逗号之后折行l在操作符之前折行l当表达式或语句有多层嵌套时，尽量避免或减少拆开嵌套层次l折行代码的缩进位置应对齐于前一行的同一嵌套层次l若沿用以上规则导致代码杂乱或者代码太靠右，就用2个Tab缩进代替这里是一些方法定义和调用的折行例子：someMethod(longExpression1,longExpression2,longExpression3,longE

3、xpression4,longExpression5);var=someMethod1(longExpression1,someMethod2(longExpression2,longExpression3));第8页共8页JAVA编程规范代码和注释规范以下是三个算术表达式的折行例子。前两个都是正确的，都避免了括弧表达式被拆开，第三种情况应当避免。longName1=longName2*(longName3+longName4-longName5)+4*longname6;//正确的longNam

4、e1=longName2*(longName3+longName4-longName5)+4*longname6;//正确的longName1=longName2*(longName3+longName4-longName5)+4*longname6;//避免的下面是两个方法定义的缩进例子。第一个是规范的例子。第二个例子，如果沿用常规的缩进规范，第二行和第三行将会紧靠右端，左边留白太多，因此用以2个Tab字符替代缩进。//规范的缩进someMethod(intanArg,Objectanother

5、Arg,StringyetAnotherArg,ObjectandStillAnother){...}//用2个Tab字符来避免缩进过深privatestaticsynchronizedhorkingLongMethodName(intanArg,ObjectanotherArg,StringyetAnotherArg,ObjectandStillAnother){...}对于if语句的折行必须用2个Tab缩进。常规的缩进可能导致别扭的代码结构，例如：//不使用这种缩进if((condition1

6、&&condition2)

7、

8、(condition3&&condition4)

9、

10、!(condition5&&condition6)){//不正确的分行doSomethingAboutIt();//可能导致此行被忽略}第8页共8页JAVA编程规范代码和注释规范//支持使用这种缩进if((condition1&&condition2)

11、

12、(condition3&&condition4)

13、

14、!(condition5&&condition6)){doSomethingAboutIt();}//或者采用这

15、种缩进if((condition1&&condition2)

16、

17、(condition3&&condition4)

18、

19、!(condition5&&condition6)){doSomethingAboutIt();}以下三种三元表达式的格式都可以接受：alpha=(aLongBooleanExpression)?beta:gamma;alpha=(aLongBooleanExpression)?beta:gamma;alpha=(aLongBooleanExpression)?beta:gamma;

20、2.4打印语句程序调试时，打印语句（System.out.println()）必须靠齐代码页左端书写，便于整理代码时去除此调试信息。3．注释规范Java程序有两种注释方式：代码注释和文档注释。代码注释类似于C++中的注释，包含在/*…*/之中或者在//之后。文档注释是Java所特有的doc注释，它以/**开始，到*/结束。文档注释主要是为支持JDK工具javadoc而采用的。Javadoc能识别注释中用标记@标识的一些特殊变量，并把doc注释加入它所生成的HTML文件。第8页共8页