shxt户籍系统代码编写规范(精简版).docVIP

Shxt户籍系统 代码编写规范 编写人：乐毅 编写日期：2010-4-30 修改人：乐毅，腾飞 最后修改日期：2010-5-17 审核人：郑名扬 审核日期：2010-5-17 目录 1 前言 5 1.1 编写目的 5 2 命名规范 5 2.1 Package的命名 5 2.2 Class的命名 5 2.3 Class变量的命名 5 2.4 接口的命名 6 2. 5方法的命名 6 2.5 参数的命名 6 2.6 数组的命名 6 2.7 方法的参数命名 6 2.8 集合对象命名规范 7 3 注释规范 7 3.1 实现注释的格式(Implementation Comment Formats) 7 3.1.1 块注释(Block Comments) 7 3.1.2 单行注释(Single-Line Comments) 8 3.1.3 尾端注释(Trailing Comments) 8 3.1.4 行末注释(End-Of-Line Comments) 8 4 Java文件样式 9 4.1 版权信息 9 4.2 Package/Imports 10 4.3 Class 10 4.4 Class Fields 10 4.5 存取方法 11 4.6 构造函数 11 4.7 克隆方法 12 4.8 类方法 12 4.9 main 方法 13 5 代码编写格式 13 5.1 代码样式 13 5.2 文档化 13 5.3 缩进 13 5.4 页宽 13 5.5 {}对 13 5.6 括号 14 6 JAVA编码规范 14 6.1 注意 14 6.2 异常处理 15 6.3 垃圾收集 15 6.4 Clone 15 6.5 final 类 16 6.6 访问类的成员变量 16 6.7 编写类的公共问题 16 7 代码编译 17 8 匈牙利命名规则 17 8.1 数据类型缩写 18 8.2 SWING一些控件的缩写 18 8.3 SWT一些控件的缩写 18 8.4 方法 19 9 部分编程常用单词缩写 19 10 编程技巧 21 10.1 byte数组转换到characters 21 10.2 Utility 类 21 10.3 初始化 21 10.4 枚举类型 21 10.5 byte[]中的值 22 10.6 String和StringBuffer 22 11 调试 22 12 性能 22  前言 编写目的 本规范是本项目组开发人员必须遵循的，可供测试等其他人员参考，本规范只适合本项目组使用。 特别注意 1、所有需要等待的程序加上进度条； 2、所有的方法加上javadoc注释，重要变量和属性也加上注释说明； 3、代码必须进行格式化，以使代码可读性强； 命名规范 定义命名规范的目的是让项目中所有的文档看起来风格统一，增加可读性，减少项目组中因换人而带来的问题和损失。 Package的命名 包（Packages）名称为com.公司名.项目名.模块名.层次名（类名包含功能）。 Class的命名 Class 的名字由一组首字母大写的单词和固定缩写组成。使类名简洁而有含义。使用完整单词，避免缩写词（除非该缩写词被更广泛使用，也可组内商讨定义，例如:DAO）。 Class变量的命名 实例名采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。变量名不应以下划线或美元符号开头，尽管这在语法上是允许的。 实例名应简洁而有含义。变量名的选用应该易于记忆，即能够指出其用途。尽量避免单个字符的变量名，除非是一次性的临时变量。临时变量通常被取名为i，j，k，m和n，它们一般用于整型；c，d，e，它们一般用于字符型。如char c、int i、float myWidth。。 常量（Constants）类常量和ANSI常量的声明，应该全部大写，单词间用下划线隔开（尽量避免ANSI常量，容易引起错误）。如：static final int MIN_WIDTH = 4、static final int MAX_WIDTH = 999、static final int GET_THE_CPU = 1。 1、尽量使用完整的英文描述符； 2、采用适用于相关领域的术语； 3、采用大小写混合使名字可读； 4、尽量少用缩写，如果使用，必须在整个工程中统一； 5、尽量避免使用较长的名字； 6、尽量避免使用类似的名字（比如两个单词只相差一个字母）； 7、禁止使