JAVA编程规范综述.doc

JAVA 编程规范 拟制人： 杜政飞 拟制时间： 2006-8-30 广州普翔软件科技有限公司 版本变更记录： 版本号 拟制日期 拟制人 版本描述 存档编号 1 2006-08 杜政飞 初次制定 目 录 前 言 1 1 范围 1 2 使用工具 1 3 代码规范 1 3.1 源文件规范 1 3.1.1 原文件后缀 1 3.1.2 常用类名约定 1 3.1.3 文件组织 2 3.1.4 编码格式 4 3.2 优化规范 18 3.2.1 容器类使用 18 3.2.2 synchronized 18 3.2.3 向变量赋null 19 3.2.4 ArrayCopy 19 3.2.5 finalize方法的使用 19 3.2.6 字符串连接 19 3.2.7 通信操作关闭 19 3.2.8 Private方法使用 19 3.2.9 使用log4j打印输出 19 3.2.10 避免使用已经被弃用的方法 20 3.2.11 Java.util.Calendar和java.util.Date设计很差劲 20 3.2.12 用反射实例化内部类需要一个额外的参数 20 3.2.13 从字节数组到字符数组的转换需要指定字符集 20 3.2.14 String.replaceAll以正则表达式作为第一个参数，以置换字符串作为第二 个参数 20 3.2.15 Char类型值只会默认转换成int,而不是String 20 3.2.16 不要尝试类自动初始化,很可能造成线程死锁 20 4 第三方控件的使用 22 前 言 为了统一后台代码的风格和提高后台代码的开发质量，制定本规范， 所有的后台代码都按照该规范执行。 范围 本规范适用于中兴软创开发二部的后台JAVA的设计开发。 使用工具 后台Java类开发的IDE采用Jbuilder,Eclipse或Idea IntellJ其中的一种，其他开发工具不予选取。一个项目统一使用其中某一种IDE。 版本控制工具采用Visual Source Safe。 代码规范 源文件规范 原文件后缀 Java源文件使用.java作为文件后缀,java字节码文件使用.class作为文件后缀。 常用类名约定 异常类名 将最后作为Exception 的类名．例:ClassNameEndsWithException 接口名 同类名．但是，如果有和class 区別的必要的话，最开始加I. 例:IAdviceHandle。 如果增加类中的某些能力时,作为表示其能力的形容词，将-able当作接尾.例: Runnable，Clonabe, Serializable, … 实现类名 特别是有和interface 区別的必要的话，最后加Impl ．例:ClassNameEndsImpl 抽象类名 从Abstract 开始,起一个联想SubClass名的名字．例:AbstractDAOImpl 文件组织 类定义 每个java源文件都包含单一的公共类或接口,若私有类和接口只与一个公共类相关联,可以将它们和公共类放在同一个源文件.公共类必须是这个文件中的第一个类或接口. 文件结构 Java源文件遵循以下规则： 开头注释 所有的源文件都应有一个C语言风格的注释,其中列出类名,版本信息,日期和版权声明: /** * Classname 类名称 * * Version information 版本信息 * * Date 日期 * * Copyright notice 版权声明 */ 包和引入语句 在多数的Java源文件中,第一个非注释行是包语句,在它之后可以跟引入语句. 例： package org.omg.CORBA import org.omg.CORBA.ARG_INOUT; 类和接口声明 下表描述了类和接口声明的各个部分和它们出现的先后次序. 类/接口声明的各部分 注解 1 类/接口文档注释(/**……*/) 该注释中所需包含的信息. 2 类或接口的声明 3 类/接口实现的注释(/*……*/)如果有必要的话 该注释应包含任何有关整个类或接口的信息，而这些信息又不适合作为类/接口文档注释。 4 类的(静态)变量 首先是类的公共变量，随后是保护变量，再后是包一级别的变量(没有访问修饰符，access modifier)，最后是私有变量。 5 实例变量 首先是公共级别的，随后是保护级别的，再后是包一级别