Java开发规范.doc

Java 开发规范 Java 编程规约 1. 目标是向开发人员提供 PF 系统里用 Java 来编程的规则和指针。规约的方针是编写易读及易维护的代码。在实际编程时, 项目组全体开发人员需严格遵守此规则。 2. 文件构成 . 文件位置 Java 源文件放入 develope 的 src 下. 包中的”.”换成对应的目录例: package 放入 develop//mon/ 目录。 3. 命名规则 . Package 名特定 package 名的前缀应是通常只用小写字母书写的最高标准的域名( 、 edu 、 gov 、 mil 、 net 、 org 、或 ISO_3166 所规定的2 个文字的字母表来表示的国家编码) 。前缀的接续部分是根据编程组织的原本的命名规则来规定。此规则规定目录名为部署、部门、 project 、 machine 或注册名。另外,由两个以上词构成的目录名也全部用小写字母来命名。例: . 文件名用该文件中的 public class 名作为文件名。例: public class Point{ …} 所以文件名为 . 类名类名首字母及各单词的首字母为大写字母。注意"Test" 这个单词在类名中不使用。例: CapitalizedWithInternalWordsAlsoCapitalized . 例外的类名例外的类名首字母为大写字母、各单词的首字母为大写字母、 Exception 用作为末尾的类名。注意"Test" 这个单词在例外的类名中不使用。( 保留作为 JUnit 的 TestClass 命名用)例: ClassNameEndsWithException . 接口名接口名首字母为大写字母、各单词的首字母为大写字母。注意"Test" 这个单词在接口名中不使用。例: NameOfInterface 另外, 要表示添加类里特定功能的接口时, 用末尾是 able 的接口名。例: Runnable 、 Clonable 、 Serializable 、… . 实现类名实现类名是在所实现的接口名末尾添加 Impl 。但是,在扩展功能实现类的情况下,根据不同用途来命名。注意"Test" 这个单词在实现类名中部使用。例: 接口 ClassNameEndsWith 的实现类。 ClassNameEndsWithImpl 接口 RequestHandler 的扩展实现类。 SalesRequestHandler . 抽象类名抽象类名从 Abstract 开始,各单词的首字母为大写字母。注意"Test" 这个单词在抽象类名中不使用。例: AbstractBeforeSubClassName . 常量类名、常量接口名常量类、常量接口在本系统无特别规定。 . 单体测试类名单体测试类名是在测试的类名的末尾添加 test 。例: DateUtil 类的测试类名是 测试类的位置测试类放在与测试对象类相同的目录里。补充:有关测试类和测试对象类分离,可用其他工具(Ant 的 ) 调整。 . 常量名常量名全部使用大写字母,单词用"_" 连接。例: UPPER_CASE_WITH_UNDERSCORES 另外,做为半常量(只作参照用)的 Map 、 List 等的 object 名也和常量名一样。 . 变量名变量名取一个有意思的名字。由2 个单词以上构成的变量名首字母为小写文字,各单词的首字母为大写文字。例: employeeStateNumber . 类变量名、接口变量名类变量名、接口变量名以"_" 开始。例: _field . 局部变量名局部变量名无特别的规定,取一有意思的名字即可。 . 方法名 . factory 方法所谓 factory 方法是指生成 object 。写成 create<ClassName>() 。例: public Employee createEmployee() . Converter 方法所谓 Converter 方法是指把 object 转换成其他的 object 。写成 to<ClassName> ()。例: public Employee toEmployee() . 属性的取得方法写成 get< 属性名> ()。例: public Employee getEmployee() . 属性的设定方法写成 set< 属性名>(…)。例: public void setEmployee(Employee emp