Java编程规范1.0

Java编程规范Ver1.0福建微创科技公司1/19Java编程规范1.0规范说明.......................................................................................................................................2第二部分排版.............................................................................................................................3第1节空行.........................................................................................................................3第2节代码行.....................................................................................................................3第3节代码行内的空格.....................................................................................................4第4节对齐.........................................................................................................................6第5节长行拆分.................................................................................................................7第7节注释.........................................................................................................................8第三部分命名规则...................................................................................................................10第四部分表达式和基本语句...................................................................................................14第五部分常量...........................................................................................................................16第六部分函数...........................................................................................................................17第1节参数.......................................................................................................................17第2节返回值...................................................................................................................17第3节函数体...................................................................................................................18第4节成员函数..................................................................................错误!未定义书签。第5节重载、覆盖和隐藏...............................................................................................18第7节其他.......................................................................................................................18第七部分内存管理...................................................................................................................19第八部分类...............................................................................................................................19第1节构造函数...............................................................................................................19第2节拷贝构造函数和赋值函数......................................................错误!未定义书签。第3节成员变量...............................................................................................................19第4节成员函数...............................................................................................................19Java编程规范Ver1.0福建微创科技公司2/19规范说明本规范各款“规则”或“建议”标准的制定原则：兼容公司的历史代码，提高公司代码的可读性、一致性和健壮性，人的效率优先而不是机器效率优先。本规范中的【规则x-x-x】部分内容为公司强制执行的标准，【建议x-x-x】部分内容为公司推荐的标准。强制标准：公司程序部的所有员工编写JAVA代码不应与该规范的规则标准相抵触，违反规则标准编写的JAVA代码，由违反者改正。建议标准：是一种良好的JAVA编程风格，由于各种因素公司只推荐使用。公司程序部员工可以不按照某款建议标准编写JAVA代码。对本规范的不同意见或建议可通过正式途径提交，公司将在下一版规范中采纳或不采纳提出的意见或建议。正式途径由程序部行政部们另行建立。Java编程规范Ver1.0福建微创科技公司3/19第二部分排版第1节空行【规则2-1-1】类声明、函数定义之后空行在每个类声明之后、每个函数定义结束之后都要加空行。参见示例2-1-1（a）【规则2-1-2】函数体内，逻辑中断空行在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。参见示例2-1-1（b）【示例2-1-1】(a-b)//空行voidFunction1(…){…}//空行voidFunction2(…){…}//空行voidFunction3(…){…}//空行while(condition){statement1;//空行if(condition){statement2;}else{statement3;}//空行statement4;}示例2-1-1(a)函数之间的空行示例2-1-1(b)函数内部的空行第2节代码行【规则2-2-1】if、for、while、do等语句自占一行执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。Java编程规范Ver1.0福建微创科技公司4/19假设if后面跟的是检查参数错误等逻辑上不可能出现的情况后不跟{}例如:if(null==user)return;示例2-2-1（a）为风格良好的代码行，示例2-2-1（b）为风格不良的代码行。【示例2-2-1】(a-b)intnWidth;//宽度intnHeight;//高度intnDepth;//深度intnWidth,nHeight,nDepth;//宽度高度深度x=a+b;y=c+d;z=e+f;X＝a+b;y=c+d;z=e+f;if(nWidthnHeight){dosomething();}if(nWidthnHeight)dosomething();for(initialization;condition;update){dosomething();}//空行other();for(initialization;condition;update)dosomething();other();示例2-2-1(a)风格良好的代码行示例2-2-1(b)风格不良的代码行【规则2-2-2】就近原则，变量在使用前才定义如果变量的引用处和其定义处相隔比较远，变量的初始化很容易被忘记。如果引用了未被初始化的变量，可能会导致程序错误。第3节代码行内的空格【规则2-3-1】‘，’之后要留空格如Function(x,y,z)。如果‘;’不是一行的结束符号，其后要留空格，如for(initialization;condition;update)。Java编程规范Ver1.0福建微创科技公司5/19【规则2-3-2】二元操作符的前后应当加空格赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符，如“=”、“+=”“=”、“=”、“+”、“*”、“%”、“&&”、“||”、“”,“^”等二元操作符的前后应当加空格。【规则2-3-3】一元操作符前后不加空格一元操作符如“!”、“~”、“++”、“--”、等前后不加空格。【规则2-3-4】“［］”、“.”这类操作符前后不加空格。【建议2-3-1】关键字之后要留空格if、for、while等关键字之后应留一个空格再跟左括号‘（’，以突出关键字。【建议2-3-2】函数名之后不要留空格紧跟左括号‘（’，以与关键字区别。【建议2-3-3】‘（’向后紧跟不留空格;‘）’、‘，’、‘;’向前紧跟不留空格紧跟处不留空格。多个”((“连在一起处可在外层加空格,”))”也是【建议2-3-4】较长表达式可以适当地去掉一些空格对于表达式比较长的for语句和if语句，为了紧凑起见可以适当地去掉一些空格，如for(i=0;i10;i++)和if((a=b)&&(c=d))【示例2-3-1】voidfunc1(intnX,intnY,intnZ);//良好的风格voidfunc1(intnX,intnY,intnZ);//不良的风格if(nYear=2000)//良好的风格if(nYear=2000)//不良的风