JAVA编码规范剖析.doc

开发命名规范 JAVA编码规范 目 录 1 概述 3 1.1 编写目的 3 1.2 预期读者 3 1.3 适用范围 3 2 命名规范 4 2.1 包命名规则 4 2.1.1 与业务系统相关的包命名 4 2.1.2 与业务系统无关的、可公用的包 4 2.2 类名、接口命名规则 5 2.3 方法命名规则 5 2.4 变量命名规则 5 2.5 常量命名规则 7 3 代码书写规范 7 3.1 返回值 7 3.2 异常 8 3.3 表达式 8 3.4 体前代码 9 3.5 注释 9 版本说明 版本 修改时间 撰写人 说明 1.0 -mm-dd 张三 初稿 概述 编写目的 本文描述了JAVA开发中的有关包、类、接口、方法、实例变量、变量和常量的命名规则，用于规范JAVA编程过程中的命名和代码书写规范。 预期读者 全体成员。 适用范围 适用于开发组所有基于JAVA开发的项目。 命名规范 包命名规则 组将基于JAVA开发中产生的包分为两类，一是与各业务系统相关的包，一是与业务系统无关的、可公用的包。它们的命名除要遵守“包名应全部是小写字母，包名中不能出现下划线，并且第一个字母不能是数字”的规则。 与业务系统相关的包命名 与业务系统相关的包命名格式为： com..projectname.modulename。 其中： projectname为项目英文简称或缩写；modulename为模块英文名称或简称。与业务系统无关的、可公用的包 包命名格式为： mon.modulename//所有项目通用 com.soft.projectname.common//单个项目内各模块通用 类名、接口命名规则 类和接口的名称应是一个名词，采用大小写混和的方式，如果使用拼音则应是全拼，所有单词都应紧靠在一起，其中每个单词的首字母应大写。例如： class ； interface ICommonConnection； class Department; 每个类定义前必须加类的说明。 方法命名规则 方法名应是一个动词，采用大小写混和的方式，其中第一个单词的首字母用小写，其后单词的首字母大写。例如： Xxxxx.get()； 每个方法前必须加说明包括：参数说明、返回值说明、异常说明。如果方法名实在是太长可以对变量名缩写，但是必须添加相应的说明。 变量命名规则 变量命名一般采用大小写混和的方式，第一个单词的首字母小写，其后单词的首字母大写，变量名一般不要用下划线或美元符号开头。变量名应简短且有意义，即，能够指出其用途。除非是一次性的临时变量，应尽量避免单个字符的变量名。 （1）类的实例对象定义如下： Person person; （2）同一个类的多个对象可以采用定义方式： Person person1； Person person2； （3）集合类的实例命名使用集合包含元素的英文名称的复数表示，例如： Vector persons; （4）如果变量名实在是太长可以对变量名缩写，但是必须在类说明或方法说明部分（视缩写的范围而定）进行说明。 （5）数组的声明要用int[] packets的形式，而不要用int packets[]。（） 前缀名称 byte b char c short s int i long l string str float f double d hashtable ht [] arr List lst Vector v StringBuffer sb Boolean bl Byte bt Map map Object ob 说明：如再追加其他类型，再行追加。 常量命名规则 类常量和ANSI常量的命名应全部用大写，单词间用下划线隔开。例如： final static int MIN_WIDTH = 4； final static int MAX_WIDTH = 99； 代码书写规范 类的方法的代码行数不能过长，尽量控制在100行（90%），长的方法要拆分成私有函数；每行不超过80个字符。 返回值 在一般情况下，方法返回值不应返回null。而是尽量使用异常代替返回null。如果在特殊情况必须返回null, 必须在方法说明中加以特别说明，如使用“特别注意”等字样。例如：从一个集合类实例中提取一个对象，因为有些集合类实例是允许null作为键或值的，这个时候用异常取代返回null就不合适了。 如果方法的返回值是集合类对象，而且返回的集合对象不包含任何元素时，则应返回0长度或0大小的集合对象。不能返回null。 异常 整个应用系统使用自行设计的唯一异常类，该类包括message（表示错误信息）和ID号（整型，表示异常类型）两部分，该类在创建时是自动获得类