资源描述：
《代码和注释要求规范.doc》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。
1、文档编号版本1.0JAVA编程规代码规注释规1．引言本文档对Java代码的编程方式、风格做了统一规，目的是减少编程人员代码编写中的语法错误，并通过增强代码的通读性和易懂性，使得代码修改和程序维护相对简单。本文档可用作公司新进人员的培训材料，也可用作检查代码编写质量的参考。2．代码规2.1缩进缩进必须用Tab键。不允许使用空格键缩进。每Tab缩进4个空格长度。2.2页宽页宽设置为80字符，即每行代码不应超过80字符数。注：写在文档中的例子每行的宽度应更短，一般不超过70字符。2.3折行当一个表达式
2、或一行语句超长时(超出页宽)，必须按以下规则进行折行：l在逗号之后折行l在操作符之前折行l当表达式或语句有多层嵌套时，尽量避免或减少拆开嵌套层次l折行代码的缩进位置应对齐于前一行的同一嵌套层次l若沿用以上规则导致代码杂乱或者代码太靠右，就用2个Tab缩进代替这里是一些方法定义和调用的折行例子：someMethod(longExpression1,longExpression2,longExpression3,longExpression4,longExpression5);var=someMet
3、hod1(longExpression1,someMethod2(longExpression2,longExpression3));以下是三个算术表达式的折行例子。前两个都是正确的，都避免了括弧表达式被拆开，第三种情况应当避免。longName1=longName2*(longName3+longName4-longName5)+4*longname6;//正确的longName1=longName2*(longName3+longName4-longName5)+4*longname6;//
4、正确的longName1=longName2*(longName3+longName4-longName5)+4*longname6;//避免的下面是两个方法定义的缩进例子。第一个是规的例子。第二个例子，如果沿用常规的缩进规，第二行和第三行将会紧靠右端，左边留白太多，因此用以2个Tab字符替代缩进。//规的缩进someMethod(intanArg,ObjectanotherArg,StringyetAnotherArg,ObjectandStillAnother){...}//用2个Tab字符
5、来避免缩进过深privatestaticsynchronizedhorkingLongMethodName(intanArg,ObjectanotherArg,StringyetAnotherArg,ObjectandStillAnother){...}对于if语句的折行必须用2个Tab缩进。常规的缩进可能导致别扭的代码结构，例如：//不使用这种缩进if((condition1&&condition2)
6、
7、(condition3&&condition4)
8、
9、!(condition5&&condi
10、tion6)){//不正确的分行doSomethingAboutIt();//可能导致此行被忽略}//支持使用这种缩进if((condition1&&condition2)
11、
12、(condition3&&condition4)
13、
14、!(condition5&&condition6)){doSomethingAboutIt();}//或者采用这种缩进if((condition1&&condition2)
15、
16、(condition3&&condition4)
17、
18、!(condition5&&conditio
19、n6)){doSomethingAboutIt();}以下三种三元表达式的格式都可以接受：alpha=(aLongBooleanExpression)?beta:gamma;alpha=(aLongBooleanExpression)?beta:gamma;alpha=(aLongBooleanExpression)?beta:gamma;2.4打印语句程序调试时，打印语句（System.out.println()）必须靠齐代码页左端书写，便于整理代码时去除此调试信息。3．注释规Java程序有两
20、种注释方式：代码注释和文档注释。代码注释类似于C++中的注释，包含在/*…*/之中或者在//之后。文档注释是Java所特有的doc注释，它以/**开始，到*/结束。文档注释主要是为支持JDK工具javadoc而采用的。Javadoc能识别注释中用标记标识的一些特殊变量，并把doc注释加入它所生成的HTML文件。代码注释可以用来注释掉（屏蔽）代码，也可用来对某一执行语句而作详细的说明。文档注释是指对代码规格的描述，这些与执行无关的说明用来给那些不需要了解和处理源代码的开发者使用。注释不能放在用星号
