Java代码编写规范.doc

Java代码编程格式规范，Java代码编程格式规范目录1前言52适用范围53命名规范53.1Package的命名53.2Class的命名53.3Class变量的命名63.4StaticFinal变量的命名63.5常量63.6前后台变量名称63.7参数的命名63.8数组的命名63.9方法的参数63.10缩写73.11标识符命名中应注意的问题73.11.1变量名禁止取单个字符73.11.2不用数字定义名字73.11.3避免标识符名字冲突83.11.4用正确的反义词组命名83.11.5避免使用84注释94.1一般情况下94.2常规注释标记说明94.2.1@since94.2.2@deprecated94.2.3@see94.2.4@link104.3类和接口注释说明104.4方法注释说明105书写格式规范115.1样式115.1.1Java文件样式115.1.2Class的样式125.1.3代码样式155.2代码编写规范155.2.1缩进155.2.2页宽165.2.3空行165.2.4空格的使用175.2.5{}的用法175.2.6循环、判断等语句185.2.7参数划分185.2.8一行只写一条语句195.2.9程序块的分界符195.3变量编写规范205.3.1公共变量205.3.2局部变量215.4程序编写规范215.4.1exit()215.4.2异常215.4.3垃圾收集225.4.4final类225.4.5访问类的成员变量226编程技巧226.1一般性原则226.1.1检查所有参数输入的有效性。236.1.2检查参数输入236.1.3类名应准确描述类的功能。236.1.4避免强制返回值类型236.1.5让调用点显得易懂、容易理解。236.1.6减少数据类型转换236.1.7防止程序中的垃圾代码。236.1.8减少递归调用。236.1.9使用数据流图246.1.10避免使用BOOL参数。246.2开发过程中的技巧246.2.1byte数组转换到characters246.2.2Utility类246.2.3初始化数组246.2.4枚举类型256.2.5Swing256.2.6Z-Order问题266.2.7不必要的对象构造266.2.8synchronized关键字266.3程序效率266.3.1注意代码的效率266.3.2提高代码效率266.3.3局部效率应为全局效率服务276.3.4循环体内工作量最小化。276.3.5仔细分析有关算法，并进行优化。276.3.6改进输入方式276.3.7提高调用不频繁的代码效率要慎重286.3.8提高空间效率286.3.9循环的位置286.3.10尽量减少循环嵌套层次。296.3.11避免循环体内含判断语句296.3.12不要一味追求紧凑的代码。307性能307.1可移植性307.1.1换行317.1.2PrintStream317.2可测性317.2.1调测317.2.2调测信息串格式317.2.3在编程中注意单元测试327.2.4测试准备327.2.5测试手段327.2.6调测开关327.2.7调试与测试327.2.8调测开关的级别和类型337.2.9编写防错程序338质量保证338.1代码质量保证优先原则338.2打开的文件要关闭338.3一致性检查348.4switch语句必须有default分支。348.5其他质量问题349代码编辑、编译、审查349.1统一编译环境349.2代码走读及评审349.3QA代码抽查359.4软件系统目录35前言为确保系统源程序可读性，从而增强系统可维护性，java编程人员应具有基本类似的编程风格，兹制定下述Java编程规范，以规范系统Java部分编程。系统继承的其它资源中的源程序也应按此规范作相应修改。适用范围本文档将作为java编程人员软件开发的编程格式规范。在项目Java部分的编码、测试及维护过程中，要求严格遵守。命名规范定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。Package的命名Package的名字应该都是由一个小写单词组成。示例：unipost.transClass的命名Class的名字每个单词必须由大写字母开头而其他字母都小写的单词组成。示例：FileMngClass成员的命名变量、方法、属性：大小写混排的单词组成，首字母小写示例：functionName、countNum、sizeStaticFinal变量的命名StaticFinal常量：大写单词组成，单词之间使用“_”连接示例：MAX_INDEX前后台变量名称前台变量fg_变量名后台变量bg_变量名参数的命名参数的名字必须和变量的命名规范一致。数组的命名数组应该总是用下面的方式来命名：byte[]buffer;而不是