JAVA系统开发的规范.doc

JAVA开发规范 编写人： 彭毅 批准人： 批准日期： 版本历史 修改日期 版本 作者/修改人 修改内容 评审号 变更控制号 2014-09-20 V1.0 彭毅 创建 无 无 目录 1 前言 4 1.1 文档目的 4 1.2 适用范围 4 1.3 名词解释 4 1.4 参考资料 4 2 Java开发规范 4 2.1 排版规范 5 2.1.1 缩进 5 2.1.2 分界符（如大括号‘{’和‘}’） 5 2.1.3 空格 6 2.1.3.1 加空格的情况 6 2.1.3.2 不加空格的情况 6 2.2 注释规范 7 2.3 命名规范 7 2.3.1 包名 7 2.3.2 类名和接口 7 2.3.3 方法名 7 2.3.4 属性名 8 2.3.5 变量 8 2.3.6 常量 8 2.4 编码规范 8 2.4.1 明确方法功能 8 2.4.2 明确类功能 9 2.4.3 三层调用顺序 9 前言 文档目的 代码规范对程序员很重要的一些原因： 一、一个软件得花费其生命周期的80%去维护。 二、几乎没有任何软件在整个生命周期中是由其原作者维护的。 三、代码规范提高了软件的可读性，能够让工程师更快、更透彻的了解新的代码。 适用范围 本规范规定了使用Java语言编程时排版、注释、命名、编码的规则。 本规范适用于使用Java语言编程的产品和项目 名词解释 术语 解释 规则 编程时强制必须遵守的原则 格式： 对此规范格式的说明。 说明： 对此规范或建议进行必要的解释。 示例： 对此规范或建议从正、反两个方面给出例子。 参考资料 编号 资料名称 作者 Java开发 程序块要采用缩进风格编写，缩进一个tab键。 示例：以下例子不规范public void add(int add,int addend){ return add + addend; } 应该如下写public void add(int add,int addend){ return add + addend; } 分界符（如大括号‘{’和‘}’） 根据我们的编码习惯，左大括号“{”位于声明语句同行的末尾，右大括号“}”另起一行，与相应的声明语句对齐，除非是一个空语句，“}”应紧跟在“{”之后。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式，空构造函数除外以下例子不规范for (...) { ... // program code } if (...) { ... // program code } void example_fun( void ) { ... // program code } public XX(){ }//空构造函数下书写for (...) { ... // program code } if (...) { ... // program code } void example_fun( void ){ ... // program code } public XX(){} 空格 在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如.），后不应加空格。 加空格的情况 一、逗号、分号只在后面加空格。 int a, b, c; 二、比较操作符, 赋值操作符=、 +=，算术操作符+、%，逻辑操作符、，位域操作符、^等双目操作符的前后加空格。 if (current_time = MAX_TIME_VALUE) a = b + c; a *= 2; a = b ^ 2; 三、if、for、while、switch等与后面的括号间应加空格，使if等关键字更为突出、明显。 if (a = b c d) 不加空格的情况 一、!、~、++、--、（地址运算符）等单目操作符前后不加空格。 flag = !isEmpty; // 非操作!与内容之间 i++; // ++,--与内容之间 二、.前后不加空格。 p.id = pid; // .前后不加空格 注释规范 目前暂时不定，尽量使用名变量名和方法名注释。如用户，如果我们命名成那么一看就知道这个方法是保存用户。 规范名 格式： cn.shengyuan.项目名称(产品).模块名称.子模块名称 应该如下写cn.shengyuan.ebp.core.dao; 通用uti