大学生就业的管理系统java命名细则.docVIP

1 概述 编写目的 本文描述了JAVA开发中的有关包、类、接口、方法、实例变量、变量和常量的命名规则，用于规范JAVA编程过程中的命名和代码书写规范。 预期读者 开发组全体成员。 适用范围 适用于开发组所有基于JAVA开发的项目。 命名规范 包命名规则(Packages) 一个唯一包名的前缀总是全部小写的ASCII字母并且是一个顶级域名，通常是com，edu，gov，mil，net，org，或1981年ISO 3166标准所指定的标识国家的英文双字符代码。包名的后续部分根据不同机构各自内部的命名规范而不尽相同。这类命名规范可能以特定目录名的组成来区分部门(department)，项目(project)，机器(machine)，或注册名(login names)。开发组将基于JAVA开发中产生的包分为两类，一是与各业务系统相关的包，一是与业务系统无关的、可公用的包。它们的命名规则除要遵守“包名应全部是小写字母，包名中不能出现下划线，并且第一个字母不能是数字”的规则。 与业务系统相关的包命名 与业务系统相关的包命名格式为： com.zdsoft.projectname.modulename。 其中： projectname为项目英文简称或缩写；modulename为模块英文名称或简称，如果无细分模块的话可省略模块名。 与业务系统无关的、可公用的包 通用包命名格式为： mon.modulename//所有项目通用 com.zdsoft.projectname.common//单个项目内各模块通用 类名(Classes)、接口命名规则(Interfaces) 类和接口的名称应是一个名词，采用大小写混和的方式，如果使用拼音则应是全拼，避免缩写词(除非该缩写词被更广泛使用，像URL，HTML),其中每个单词的首字母应大写，接口名称应以大写I开始。例如： class User； interface ICommonConnection； class BuMen;//此处为部门全拼 每个类定义要前必须加类的说明。 方法命名规则(Methods) 方法名应是一个动词或动名结构，采用大小写混和的方式，其中第一个单词的首字母用小写，其后单词的首字母大写。例如： Xxxxx.getBmList()； 每个方法前必须加说明包括：参数说明、返回值说明、异常说明。如果方法名实在是太长可以对变量名缩写，但是必须添加相应的说明。 变量命名规则(Variables) 变量命名一般采用大小写混和的方式，第一个单词的首字母小写，其后单词的首字母大写，变量名一般不要用下划线或美元符号开头。变量名应简短且有意义，即，能够指出其用途。除非是一次性的临时变量，应尽量避免单个字符的变量名。 （1）类的实例对象定义如下： Person person; （2）同一个类的多个对象可以采用一下定义方式： Person person1； Person person2； （3）集合类的实例命名使用集合包含元素的英文名称的复数表示，例如： Vector persons; （4）如果变量名实在是太长可以对变量名缩写，但是必须在类说明或方法说明部分（视缩写的范围而定）进行说明。 （5）数组的声明要用int[] packets的形式，而不要用int packets[]。 常量命名规则(Constants) 类常量和ANSI常量的命名应全部用大写，单词间用下划线隔开。例如： final static int MIN_WIDTH = 4； final static int MAX_WIDTH = 99； 2.6 实例变量(Instance Variables) 变量命名一般采用大小写混和的方式，第一个单词的首字母小写，其后单词的首字母大写，变量名一般不要用下划线或美元符号开头。变量名应简短且有意义，即，能够指出其用途。除非是一次性的临时变量，应尽量避免单个字符的变量名。除此之外在前面需要一个下划线。 例如： int _employeeId; String _name; 2.7 推荐的命名 2.7.1 类名推荐 当要区别接口和实现类的时候，可以在类的后面加上“Impl”。例如： interface Container class ContainerImpl class Container3PImpl class ContainerYICTImpl 2.7.2 Exception类名推荐 Exception类最好能用“Exception”做为类命名的结尾。例如： DataNotFoundException InvalidArgum