后台Java程序编码标准.doc

Forpersonaluseonlyinstudyandresearch;mercialuseJava程序编码规范后台技术中心编写人:汪源编写时间:2009-3-27部门名:后台技术中心修订记录编号修订内容简述修订日期版本修订人1初始版本2009-3--8编码。代码使用大小为4的TAB缩进。代码使用package组织,。使用Vector等集合框架类时,应指定模板类型参数。命名规范类名、文件名、枚举变量等统一使用首字母大写,如classTableInfo{ ...};函数参数、局部变量、函数名等统一使用Sun风格的命名,即第一个单词小写,其它单词首字母大写,如:intmaxLength;NtseIndex*primaryKey;booldropTable(...){ //}不允许使用匈牙利式命名法。常量统一使用全大写,单词之间用_连接,如:staticfinalintNTSE_NAME_LEN;目录名统一使用全小写字母,单词之间用-连接。语句主要是{放在同一行及空格使用上的约定。if/else形如(注意其中每个空格的位置):if(xxx){ ...}elseif(xxx){ ...}else{ ...}for/while形如:for(xxx;xxx;xxx){ ...}while(xxx){ ...}switch形如:switch(xxx){caseaaa: ... break;casebbb: ... break;default: break;}函数定义形如:intfoo(intp1,intp2){ ...}try/catch形如:try{ ...}catch(SomeException&e){ ...}finally{ ...}空白基本的风格是操作符的两边都要用空格,如:a=b*2+c;但++/--操作与表达式之间不要用空格,如应使用:i++;i--;而不要使用i++;i--;;与,操作符应该前边没有空格,后边有空格,如应使用:for(i=0;i<100;i++) some_func(arg1,arg2,arg3);而不要使用for(i=0;i<100;i++) some_func(arg1,arg2,arg3)注释统一使用Java风格的注释,如函数注释形如:/**函数简要声明**[可选]函数详细说明****@pre先验条件,在调用函数之前必须满足的条件****@post后验条件,函数完成之后必须满足的条件****@param参数1参数说明****@param参数2参数说明*...****@throwSomeException异常说明****@return返回值说明*/注释写在哪里被子类重写的虚函数的注释应该写在基类中,如果子类的实现没有什么特殊之处,在子类中写"***@see基类函数"即可,没有必要将一个注释拷贝多份。各对象注释规范开发人员应该为项目主体实现代码中的所有类、类成员、函数等书写完整的注释。单元测试等非主体实现代码的注释要求由主管根据项目需要决定。代码质量进行良好的功能分解与模块划分,各模块应拥有明确单一的职责,遵循高内聚低耦合的原则;保持代码的封装性,各模块不应对外透露不必要的实现细节,使用各模块时,防止依赖于模块的内部实现或对模块的实现做各种假设;代码重复是代码中最最常见的问题,尽量消除重复代