Java编程规范精要.docVIP

JAVA编程规范  文档修订记录 版本 完成人 修改内容 审核 批准 时间 目 录 1. 引言 4 1.1. 目的 4 1.2. 范围 4 1.3. 术语定义 4 2. 格 式 5 2.1. 缩进、换行、空格 5 2.2. 类成员的摆放顺序 6 2.3. 文件格式 6 2.4. 行最大长度 7 2.5. 括号 7 3. 命名规则 8 3.1. 类和接口 8 3.2. 包 8 3.3. 方法名 8 3.4. get和set方法（属性的定义） 8 3.5. 变量 9 3.5.1. 普通变量： 9 3.5.2. 常用对象变量 9 3.5.3. 类的属性名 9 3.5.4. Static Final变量的命名 10 3.5.5. 临时变量 10 4. 注 释 11 4.1. 要求 11 4.2. JavaDoc说明 11 4.3. 类 13 4.4. 方法 14 4.5. 代码的自我说明 15 5. 编 码 16 5.1. 不要使用的结构 16 5.2. 不要混合使用递增和递减运算符 16 5.3. 变量初始化 16 5.4. 魔鬼数字/字符 17 5.5. 范围（scope） 17 5.6. 其它 17 6. JTest规范 18 6.1. 1－2级 18 6.2. 3级或以上 18 引言 Java语言给了程序员充分的空间随意编写自己的代码，但也正是因为如此，一个程序员自己编写的代码往往不能被别的程序员很好的阅读和理解。 目的 本文档旨在提供一个编码的标准，以便所有Java代码在产生的一开始就能够在整个开发团队中保持一致，从而能够更好的阅读和修改代码。 范围 在每个项目开发中一定要遵守本文档中的规定术语定义 术语定义 Logger - 系统进行日志输出了类，为引用第三方（Apache Group）的输出类，具体用法见 Log输出规范的说明。 格 式 缩进、换行、空格 所有的缩进皆为4个空格。分界符（如大括号{ }）应各自独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始，类和接口的定义以及if/for/do/while/switch/case等语句中均要采用此种缩进方式。 所有的缩进是由Space(空格)键形成的，而不是Tab键。 所有的if、while和for语句中的状态内容必须用括号括起来，就算只有一个状态。 较长的语句、表达式或参数（80字符）要分为多行书写。长表达式在低优先级操作符处划分新行，操作符放在行首，新行适当缩进。 不允许多个短语句写在一行，即一行只写一条语句。 if/for/do/while/switch/case/default等语句自占一行，且if、for、do、while等语句的执行语句无论多少都要加括号{}。 相对独立的程序块之间、变量说明之后必须加空行。 在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符前后要加空格。进行非对等操作时，如果是关系密切的立即操作符（.）后不应加空格，多重括号间不应加空格。If/for/while/switch等与后面的括号间应加空格，使关键字更为突出、明显。 例如： void foo() { String filename = System.getProperty(“user.dir”) + File.separator + “datafile.txt”; while ( bar 0 ) { Logger.debug(); bar-- ; } if ( oatmeal == tasty ) { Logger.debug(Oatmeal is good and good for you); } else if ( oatmeal == yak ) { Logger.debug(Oatmeal tastes like sawdust); } else { Logger.debug(tell me pleeze what iz dis oatmeal); } switch( suckFactor ) { case 1: Logger.debug(This sucks); break; case 2: Logger.debug(This really sucks); break; default: Logger.d