JAVA编程规范JAVA编程规范.doc

JAVA编程规范Java Coding Conventions （V1.0） 编制单位：xxxx有限公司 项目名称：xxxxx系统 项目代号：xxx_ZYZQ 文档名称：JAVA软件编程规范 文档作者: xxxx 文档审核：xxx 编制日期：20xx-05-29 修订纪录： 日期 变动记录 编写 审核 20xx-05-29 初稿 xxx xxxx 目录 一、 命名 4 1、 字符集 4 2、 Package的命名 4 3、 Class的命名 4 4、 变量的命名 4 5、 Static、Final变量的命名 4 6、 参数的命名 4 7、 数组的命名 5 8、 方法的命名 5 二、 注释 5 1、 文档化 5 2、 使用中文 5 3、 版权信息 5 4、 Class 6 5、 Class Fields 6 6、 方法 6 7、 典型算法、过程 6 三、 风格 7 1、 Package/Imports 7 2、 缩进 7 3、 页宽 7 4、 {} 对 7 5、 括号 8 6、 换行 8 7、 续行 8 8、 运算符之间的间隔 9 四、 程序编写规范 9 1、 类的组织形式 9 2、 方法（函数） 9 3、 变量 10 4、 基本数据类型 10 5、 条件语句 11 6、 循环语句 11 7、 循环变量 11 8、 禁止使用goto语句 11 9、 重载 11 10、 main方法 11 11、 资源的释放 12 12、 其它 12 五、 类设计原则 12 六、 调试 14 七、 性能 15 八、 开发系统维护 15 1、 专人负责 15 2、 VSS 15 3、 系统维护 16  命名 字符集 对于所有标识符使用的有效字符集都必须是： ‘a’--‘z’，‘A’--‘Z’，‘0’--‘9’，‘_’。 并且所有命名应以字母开头。 Package的命名Package 的名字应该都是由一个小写单词组成。 Class的命名Class 的名字必须由大写字母开头，后面的单词用大写字母开头。 例如： public class WhiteHorse { } 变量的命名’_’字符。 例如： private static float sumDiffSquares = 0; 相反： private static float Sum = 0; private static float sumdiffsquares = 0; private static float sum_diff_squares = 0; private static float x = 0; Static、Final变量的命名Static、Final 变量的名字应该都大写，并且指出完整含义。etCounter (int size) { this.size = size; } 数组的命名 数组应该总是用下面的方式来命名： byte[] buffer; 而不是： byte buffer[]; 方法的命名 和变量的命名规范一致。 注释 文档化 必须用 javadoc 来为类生成文档。不仅因为它是标准，这也是被各种 java java 文件的开头，比如： /** * Copyright ? 2000 Shanghai XXX Co. Ltd. * All right reserved. */ 其他不需要出现在 javadoc 的信息也可以包含在这里。Class 接下来的是类的注释，一般是用来解释类的，必须有。 /** * 类名定义奔驰车模型 * 类的设计目的、思想此类是为国际汽车评展会期间的进行各类汽车的比较 * 而设计的模型，需要重点突出各类汽车的优势与风格。 * 类的简要功能说明此类通过继承普通汽车实现了汽车的一般特征与行为， * 并且定义了奔驰车所特有的属性，如车载GPS，还展示了奔驰车与众不同的 * 冰面行驶、沙漠越野效果等。 */ public class Bens extends Car Class Fields 接下来是类的成员变量： /** * 汽车发动机 * 在实例化汽车时会实现此发动机。 */ protected Engine engine; public 的成员变量必须生成文档（JavaDoc）。proceted、private和 package /** * 函数名冰面行使 * 功 能展示了奔驰车以各种速度在冰面上的行使状况。 * @param double speed 汽车速度（公里/小时） * @see * @return * @exception CarException */ public void