文档介绍：羁***蒇Shxt户籍系统螁肀代码编写规范蚆羃螂膈肆编写人:乐毅螄编写日期:2010-4-30袄修改人:乐毅,腾飞薀最后修改日期:2010-5-17蝿审核人:郑名扬蒄审核日期:2010-5-17蚁虿膈膄螃肁薈羅螄腿肇蚅目录薁薂1 前言 编写目的 5蒆2 命名规范 Package的命名 Class的命名 Class变量的命名 接口的命名 参数的命名 数组的命名 方法的参数命名 集合对象命名规范 7膁3 注释规范 实现注释的格式(mentFormats) 块注释(ments) 单行注释(Single-ments) 尾端注释(ments) 行末注释(End-Of-ments) 8膃4 Java文件样式 版权信息 Package/Imports Class ClassFields 存取方法 构造函数 克隆方法 类方法 main方法 13袈5 代码编写格式 代码样式 文档化 缩进 页宽 {}对 括号 14莂6 JAVA编码规范 注意 异常处理 垃圾收集 Clone final类 访问类的成员变量 编写类的公共问题 16膀7 代码编译 17袀8 匈牙利命名规则 数据类型缩写 SWING一些控件的缩写 SWT一些控件的缩写 方法 19肇9 部分编程常用单词缩写 19肆10 编程技巧 byte数组转换到characters Utility类 初始化 枚举类型 byte[]中的值 String和StringBuffer 22羆11 调试 22薇12 性能 22膂螁虿前言肃编写目的膃本规范是本项目组开发人员必须遵循的,可供测试等其他人员参考,本规范只适合本项目组使用。袀特别注意聿1、所有需要等待的程序加上进度条;螃2、所有的方法加上javadoc注释,重要变量和属性也加上注释说明;羁3、代码必须进行格式化,以使代码可读性强;肈命名规范蒈定义命名规范的目的是让项目中所有的文档看起来风格统一,增加可读性,减少项目组中因换人而带来的问题和损失。薄Package的命名肂包(Packages).(类名包含功能)。莁Class的命名羇Class的名字由一组首字母大写的单词和固定缩写组成。使类名简洁而有含义。使用完整单词,避免缩写词(除非该缩写词被更广泛使用,也可组内商讨定义,例如:DAO)。芄Class变量的命名膃实例名采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写。变量名不应以下划线或美元符号开头,尽管这在语法上是允许的。葿实例名应简洁而有含义。变量名的选用应该易于记忆,即能够指出其用途。尽量避免单个字符的变量名,除非是一次性的临时变量。临时变量通常被取名为i,j,k,m和n,它们一般用于整型;c,d,e,它们一般用于字符型。如charc、inti、floatmyWidth。。莇常量(Constants)类常量和ANSI常量的声明,应该全部大写,单词间用下划线隔开(尽量避免ANSI常量,容易引起错误)。如:staticfinalintMIN_WIDTH=4、staticfinalintMAX_WIDTH=999、staticfinalintGET_THE_CPU=1。肅1、尽量使用完整的英文描述符;羁2、采用适用于相关领域的术语;袁3、采用大小写混合使名字可读;螆4、尽量少用缩写,如果使用,必须在整个工程中统一;螅5、尽量避免使用较长的名字;羂6、尽量避免使用类似的名字(比如两个单词只相差一个字母);羀7、禁止使用仅仅是大小写有区别的名字;葿8、除常量外,尽量避免使用下划线及$符。薅接口的命名肄接口名应以Impl或I字母开头肈大小写规则与类名相同,如:interfaceImplRasterDelegate、interfaceIStoring。(Methods)名采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写。如:run()、runFast()、getBackground()。袁参数的命名蒀参数的命名规则和实例的命名规则