编码规范(JAVA)解读.docVIP

Java程序编码规范 文档信息：文档及编码规范 文档名称：文档及编码规范 文档类别：CMM模板 文档修订记录 版本编号或者更改记录编号 *变化 状态 简要说明（变更内容和变更范围） 日期 变更人 批准日期 批准人 *变化状态：A——增加，M——修改，D——删除 文档审批信息 序号 审批人 角色 审批日期 签字 备注  目 录 1 声明 4 1.1 目的 4 1.2 范围 4 2 代码组织与风格 4 2.1 基本规格 4 2.2 空行 4 2.3 代码块长度 4 2.4 “{”，“}” 5 2.5 行宽 5 2.6 空格 6 2.7 换行 6 2.8 SQL语句编写 6 2.9 控制结构编写 7 3 命名规范 9 3.1 命名的基本约定 9 3.2 标示符的命名约定 10 3.3 声明 12 3.4 初始化 13 3.5 语句 13 3.6 错误处理和异常事件 13 3.7 可移植性 13 3.8 其他特性 14 4 注释规约 17 4.1 注释的基本约定 17 1 声明 1.1 目的 本规范为一套编写高效可靠的Java代码的标准、约定和指南。它以安全可靠的软件工程原则为基础，使代码易于理解、维护和增强，提高生产效率。同时，将带来更大的一致性，使软件开发团队的效率明显提高。 1.2 范围 本规范应用于采用J2EE规范的项目中，所有项目中的JAVA代码（含JSP，SERVLET，JAVABEAN）均应遵守这个规范。同时，也可作为其它项目的参考。 2 代码组织与风格 2.1 基本规格 为使代码更具有可读性，每行应只写一条语句。 每行代码应该在开始之前插入适当的缩进。每级缩进为一个Tab符，建议在使用Tab符前，要首先设置IDE配置参数，以保证Tab的长度为4个空格。 原则是1行1个声明，1行1条语句（不能用逗号和冒号同时声明）特别是有初始化值的时候，必须单独使用1行。 如：int i; // 建议使用 int k , n= 1 ;//禁止使用 2.2 空行 适当的增加空行，来增加代码的可读性。 在下列情况下应该有两行空行： 同一文件的不同部分之间； 在类、接口以及彼此之间。 在下列情况之间应该有一行空行： 方法之间； 局部变量和它后边的语句之间； 方法内的功能逻辑部分之间。 2.3 代码块长度 为方便浏览，每个代码块尽量控制在1个屏幕之内。代码块最好不超过400行。 2.4 “{”，“}” A. 程序的分界符开括号“{”应放置在所有者所用行的最后，其前面留一个空格；闭括号“}”应独占一行并且与其所有者位于同一列。 B. “{ }”之内的代码块在“{”右边一个缩进单位（预定义好的Tab宽度）处左对齐。 for(int i = 0; i n; i++) { DoSomeThing(); } …… 2.5 行宽 A. 代码行最大长度宜控制在80个字符以内。代码行不要过长，否则不便于浏览，也不便于打印。 B. 长表达式要在低优先级操作符处拆分成新行，操作符放在新行之首（以便突出操作符）。拆分出的新行要进行适当的缩进，使排版整齐，语句可读。 if((very_longer_variable1 = very_longer_variable12) (very_longer_variable3 = very_longer_variable14) (very_longer_variable5 = very_longer_variable16)) { dosomething(); } void SomeFunction (String leftMatrix, String rightMatrix); for(very_longer_initialization; very_longer_condition; very_longer_update) { dosomething(); } C．利用局部变量，降低表达式复杂性 例: double length = Math.sqrt(Math.pow(Math.random(), 2.0) + Math.pow(Math.random(), 2.0)); //建议方针 double xSquared = Math.pow(Math.random(), 2.0); double ySquared = Math.pow(Math.random(), 2.0); double length = Math.sqrt(xSquared + ySquared); 2.6 空格 A. 关键字之后要留空格