《JAVA代码开发规范》.docVIP

东软公司开发部  日期 变更内容 变更人 审定人 审定日期 2005/5/27 新建 王晓 2007/7/5 审定 乔巍 1 JAVA 编程规范 1．1模型构建 【源文件结构】 Java程序源文件，每文件1000行左右。每行80列以内。一个源文件包括一个类，和它的关联的内部类。源文件结构应该如下 文件头 部 Package引入部分 部 类定义 部 全局变量定义 部 内部变量定义 部 常量定义 部 全局方法定义 部 类方法定义 部 文件头 ?记录功能概要、变更履历。 ?声明所属的Package Package引入部分 用import引入需要使用的Package 一个Package中需要引入一个以上的类的时候，应使用[*]。 引入类按照以下的顺序。 import java.*; import javax.*; import oracle.*; import基底类; 类定义部分 ?定义类。 ?指定继承的类和要实现的接口。 全局变量定义变两部 ?定义类全局变量。 内部变量定义部分 ?定义类内部变量。 构造函数定义部分 ?定义构造函数及初始化处理。 Instance方法定义部分 ?Instance方法定义。 类方法定义部分 ?方法定义。 1．2编程规则 定义名字 常量、变量、方法应该使用有明确意义的名字。 【注意】 所有的变量，都应该明确申明，并加以注释。 执行中不能变更的常量、应使用final制定。 类内部使用的变量，应该使用private封装。 （例） 　　String strCname; /* 名字 */ 　　int intType; /* 类型 */ 　　int intFlags; /* 标记 */ 　　int intValue; /* 值 */ 【类】 ?类名采用小写字母，每个单词首字母大写，类名首字母大写。 完成的应用程序的tected.private使用都应明确标识 缩进使用以下格式。 　　使用Tab（4列）。 【常量】 状态标记和频繁使用并且不能变更的的常量，用final定义。 常量名应有明确的意义。 常量名全部用大写字母。 【方法】 方法名基本用小写字母，单词首字母大写，方法名首字母小写。 方法的返回值和参数类型应明确申明。 取值的方法用getXxxxx()命名，加[get]前缀。 设置变量的方法用setXxxxx()命名，加[set]前缀。  【变量定义】 全局变量、应该是拥有明确意义的变量名 变量名的命名方法，基本用小写文字，首字母小写，单词首字母大写。 相同全局常量名，在不同的类中应该有相同意思。 局部变量，在同一个方法里应该有同样的意义。在处理内部不得重复定义。同样，全局变量名在方法中不得再次定义。 变量名字应加类型后缀。 变量名应该是用可以说明该变量意义的名字。 数据类型 后缀标识 boolean Bol char Chr byte Byt int Int long Lng float Flt double Dob String Str Vector Vct HashMap Hsm HashTable Hst 其它 可以识别类型的3列后缀 方法定义 【定义】 尽量避免定义过长的方法。方法过长的标准如下。 (a)包含有200行以上的程序。 (b)包含4个以上的判断条件或者循环的方法。 正确处理的基础上，不能分割的程序段例外。 【参数】 7个参数或者参数个数可变的方法应避免定义 【返回值】 没有返回值的方法，应明确返回类型void。 程序正文 【一般规则】 一行种执行一个操作。 一个操作太长的行，应在不破坏程序意义处分割书写。 缩进使用Tab(4列)。 表达式的分割，以变量为界，下一行变量的开始与本行变量缩进到同一列。 变量和运算符之间，用一个空格（半角）隔开。 括号中的变量之间，不得有空格。 逗号(,)封号(;)和下一个变量之间、不得有空格。 【例】 intLen = intValue1 + intValue2 + intValue3 + intValue4; 调用方法参数太多需要分行的情况下、以参数为界分割、下一行变量的开始与本行变量缩进到同一列。 【例】 intStatus = file.sort(getNextRecoed, putSortedRecords, sortAscending, keyDescriptors); 【控制语句的缩进】 if、for、while语句，如果执行语句在一条以上