《java编码规范》由会员分享，可在线阅读，更多相关《java编码规范（60页珍藏版）》请在金锄头文库上搜索。
1、*一、JAVA 编码规范1.编码规范概述 2.文件体系结构规则 3.文件命名规则 4.排版规则 5.注释规则 6.命名规则 7.变量 8.方法 9.可读性 10. 程序效率 11. 质量保证*1.编码规范概述制定编码规范的最主要的目的是为了对产出代码的长期维护。通常负责 维护代码的人大多都不是开发者本人，如果有一个统一的代码格式以及 说明就可以减少混淆提高理解速度。 范围 编码规范定义了所有代码编写者在编写Java代码时应遵守的一些规 则和习惯。 本规范采用以下术语描述： 规则：编程时强制必须遵守的原则。 建议：编程时必须加以考虑的原则。 示例：对此规则或建议给出例子。*2.文件体系结构规则2
2、.1 文件体系规则规则2.1.1 JSP文件目录结构 |cgi 存放cgi程序 |cgi-bin 存放cgi编译后的程序 |css 存放样式表 |html 存放临时生成的报表文件 |images 存放图片 |include 存放系统要引用的文件 |js 存放javascript脚本 |ocx 存放ocx控件 |page 存放JSP页面 |模块分类名 |WEB-INF WEB 配置文件，class 文件*2.文件体系结构规则2.1 文件体系规则建议2.1.2 Java文件目录结构 |模块分类 |action 存放action（控制层）文件 |dao 存放dao（数据层）文件 |form 存放fo
3、rm（展示层）文件 |service 存放业务逻辑文件 |vo 存放数据对象文件*2.文件体系结构规则2.2 源文件结构规则规则2.2.1 包和引入语句 先写包语句，再写引入语句。 package行和import行之间留一行空行。 引入的标准包名要在本地包名之前，并且包名按照字母顺序排列。 如果 import 行中包含了同一个包中的类超过5个，则用 * 来处理。 import的标准包和本地包之间留一行空行。 示例：package com.sitech.crmpd.core.codegen;import java.sql.DatabaseMetaData; import java.sql.Res
4、ultSet;import com.sitech.crmpd.core.config.Config; import com.sitech.crmpd.core.jdbc.ConnectionFactory;*2.文件体系结构规则2.2 源文件结构规则规则2.2.2 类/接口 先写类/接口注释，标明类/接口的用途、版本、作者等信息。 类/接口注释之后空一行，然后写类/接口声明。 extends 和 implements写在不同行。 异常也单写一行。 示例：public class CounterSetextends Observableimplements Cloneablethrows XXX
5、XXX*2.文件体系结构规则2.2 源文件结构规则规则2.2.3 类变量的声明顺序是 public,protected,package,private 公共变量（Public） 保护变量（Protected） 包一级别的变量（没有访问修饰符) 私有变量（Private）*2.文件体系结构规则2.2 源文件结构规则 规则2.2.4 变量、常量的注释应放在其上方相邻位置或右方 规则2.2.5 用递增的方式写构造器（比如：参数多的写在后面） 规则2.2.6 类变量的存取方法：get和set方法 规则2.2.7 如果定义main() 方法，必须将main方法写在类的底部*3.文件命名规则3.1 Str
6、uts配制文件命名sc-模块名.xml3.2 jsp文件命名模块名_main.jsp 主文件 模块名_xxx.jsp xxx命名详见附录A：词典规范 sxxxx文件夹，xxxx为opcode fxxxx_x.jspxxxx opcode，x序号3.3 jsp文件命名模块名Action.java action文件 模块名Form.java form文件 模块名Svc.java service文件 表 名Dao.java dao文件 表 名Vo.java vo文件 表 名PK.java 主键的vo文件*4.排版规则4.1 方法排版规则规则4.1.1 方法名和其后的括弧之间不应有空格 示例：int
7、getResult(int forInt, char forChar)规则4.1.2 缩进采用4个空格 注意：一定要使用空格键。这样可以避免使用不同的编辑器阅读程序 时，因TAB键所设置的空格数目不同而造成程序布局不整齐。*4.排版规则4.1 方法排版规则规则4.1.3 在方法的局部变量声明和语句之间加一个空行 示例：void method1() / 声明 int anInt = 0; String aString = null; Object anObj = null;/ 语句 if (condition) *4.排版规则4.1 方法排版规则 规则4.1.4 块注释或单行注释之前必须有一行空
8、行 规则4.1.5 方法内的两个逻辑段之间必须有一行空行 建议4.1.6 在方法的每个参数之间的逗号后面加一个空格*4.排版规则4.2 语句排版规则规则4.2.1 简单语句每行至多包含一条语句 示例：argv+; / 正确 argc-; / 正确 argv+; argc-; / 不允许这样使用！规则4.2.2 复合语句被括其中的语句缩进一个层次 。*4.排版规则4.2 语句排版规则规则4.2.3 左大括号“”应位于复合语句起始行的行尾；右大括号 “”应 另起一行并与复合语句首行对齐。 示例： for (initialization; condition; update) statements;
9、 *4.排版规则4.2 语句排版规则规则4.2.4 必须用“”和“”将if内的语句括起来。(即使只有一条语 句 的情况下)正确： if(condition) System.out.println(“正确”); 错误：if(condition) System.out.println(“正确”);*4.排版规则4.2 语句排版规则规则4.2.5 在多层嵌套的if语句中，需以尾端注释的方式表示出层次关系示例：for (expr1; expr2; expr3)规则4.2.6 for语句中的表达式要用空格分开 规则4.2.7 在多层嵌套的for语句中，应以尾端注释的方式表示出层次关系 *4.排版规则4.
10、2 语句排版规则规则4.2.8 每当一个case顺着往下执行时(因为没有break语句)，通常 应在break语句的位置添加注释。下面的示例代码中就包含注释 /* falls through */ 示例：一个switch语句应该具有如下格式： switch (condition) case ABC:statements;/* falls through */case DEF:statements;break;case XYZ:statements;break;default:statements;break; *4.排版规则4.2 语句排版规则建议4.2.9 大括号可以被用于所有语句，包括单个
11、语句，只要这些语 句是诸如if-else或for控制结构的一部分建议4.2.10 关键词for和后面的括号之间加一个空格建议4.2.11 关键词while和后面的括号之间加一个空格建议4.2.12 关键词switch和后面的括号之间加一个空格*4.排版规则4.2 语句排版规则建议4.2.13 关键词try catch finally和后面的括号之间加一个空格示例：try statements; catch (ExceptionClass e) statements; try statements; catch (ExceptionClass e) statements; finally sta
12、tements; *4.排版规则4.3 表达式排版规则规则4.3.1 左括号和后一个字符之间不应该出现空格, 同样, 右括号和 前一个字符之间也不应该出现空格a = (a + b) / (c * d);规则4.3.2 用空格分隔所有的二元运算符（除了“.“）和操作数 示例：i+; J-;规则4.3.3 一元操作符和操作数之间不加空格 一元操作符包括负号（-）、自增（+）、自减（-）。 示例：*4.排版规则myMethod(byte) aNum, (Object) x); myMethod(int) (cp + 5), (int) (i + 3) + 1);规则4.3.4 强制转型后要跟一个空格
13、 示例：(x = 0) ? x : -x;规则4.3.5 当三元运算符“ ? : ”的“?”之前出现包含二元运算符的 表达 式时，给表达式添加一对圆括号 示例：*4.排版规则建议4.3.6 单行不应超过80个字符断行的原则是： 在逗号后。 在操作符前。 在较高的层次断行。 所断的行之间要对齐。第一次断行比上一行缩进4个字符。 *4.排版规则someMethod(longExpression1, longExpression2, longExpression3, longExpression4, longExpression5);var = someMethod1(longExpression1
14、, someMethod2(longExpression2, longExpression3);longName1 = longName2 * (longName3 + longName4 - longName5) + 4 * longname6; / 更好一些longName1 = longName2 * (longName3 + longName4 - longName5) + 4 * longname6; / 避免这样使用alpha = (aLongBooleanExpression) ? beta : gamma; alpha = (aLongBooleanExpression) ?
15、beta: gamma; alpha = (aLongBooleanExpression)? beta : gamma; 示例：*5.注释规则5.1 类注释规则规则5.1.1 使用JavaDoc，列出功能、版本信息、日期、作者和版权声明示例：/* Title: 缴费* Description: 缴费* Copyright: Copyright (c) 2006* Company: SI-TECH * author xxxx* version 1.0*/*5.注释规则规则5.1.2 如果对文件进行了修改，必须说明修改目的、修改日期、修改 人，并变更版本信息 示例：/* Title: 缴费* Description: 缴费* Copyright: Copyright (c) 2006* Company: SI-TECH * author xxxx* version 1.0* 修改日期 修改人 修改目的*/*5.注释规则5.2 类方法注释规则 使用JavaDoc。示例：/* * param CustID: 客户ID * return
