[计算机]Java编程规范.doc

Java编码规范 制定本编程格式的目的是为了使软件可读性好、兼容性好、易维护等等。 注：加（*）者为重要保证要求。 一、命名规范 1.1 Package 的命名(*) Package 的名字应由一个小写单词组成。为了保证包的唯一性，一般以公司国际域名开头。 例如：com.te。 1.2 Class 的命名(*) Class 的名字必须由大写字母开头，并且其它单词的首写字母也要大写。 例如：DbAccess。 1.3 Class 成员属性及变量的命名(*) 变量/成员属性的名字用一个小写字母开头，后面的单词以大写字母开头。 例如：private String lastName; 1.4 常量的命名(*) Java 里的常量，是用static final 修饰的，应该用全大写加下划线命名，并且常量名应尽量指出 完整含义。如： public static final String ORACLE_DB_DRIVER = oracle.jdbc.driver.OracleDriver ; 1.5 数组的命名 数组应该总是用下面的形式来命名： byte[] buffs; 而不是： byte buffs[]; 1.6 方法的参数 和变量的命名规范一致，且应使用有意义的参数命名，如果可能的话，使用和要赋值的 属性一样的名字，如： setCounter(int size){ this.size = size; } 1.7 方法命名(*) 用一个小写字母开头，后面的单词以大写字母开头。应意义明确，对于属性的存取方法， 应使用getXXX()和setXXX()名称，以isXXX()，hasXXX()来命名返回值为boolean 类型的 方法。 1.8 一般命名注意事项 a. 用有意义的名字命名变量 首先，用完整的英语单词或约定俗成的简写命名变量，鼓励多用约定俗成的简写命名变量。 例如： public String zipCode public int errNo b. 用复数命名Collection 类变量 Collection， 包括数组，Vector 等。命名时使用复数： 例如： public Collection customers 二、Java 源文件样式 Java(*.java) 源文件应遵守如下的样式规则 2.1 Class 代码布局： package Javadoc 注释或者其它文件头注释 类声明 Fields 声明 空行 构造函数 空行 克隆方法 空行 其它方法（不包括main) 空行 内部（Inner）类 空行 main()方法 2.2 版权信息 版权信息必须在java 文件的开头， 例如： /** * pTitle:编码过滤器 /p * pDescription: 该类实现把request请求编码为web.xml文件中所配置的字符集/p * pCopyright: Copyright (c) 2003/p * pCompany: 广州德易计算机科技有限公司/p * @author 张三 * @version 1.0 */ 2.3 Package/Imports(*) package 行要在版权信息之前，中间空一行。 将import 的classes 归类，按顺序罗列： a. Java 标准类(java.*) b. Java 扩充类(javax.*) c. 第三方类 d. 你的应用程序的类 每一类空一行。 注意在第三方类里进行注释，说明它们的来源。如果import 行中包含了同一个包中的 多个类，不推荐用import pakage.* 来处理，推荐把要用的类一一import出来。这样程序 用到哪些类就可以非常清楚的看出来，有利于代码的维护，增强了代码的可读性。 例如： import java.util.Observable; import java.util.Date; import javax.sql.Connection; //Apache Xerces import org.apache.xml.*; import org.apache.xerces.dom.*; //Application classes import com.te.db.DbAccess 2.4 Class Fields 类的成员变量： /** * Packet counters */ protected int[] packets; public 的成员变量必须以生成文档（JavaDoc）的方式进行注释（/** … */）。protected、 private 和package 定义的成员变量如果名字含义明确的话，可以没有注释。 Field 定义可遵从以下顺序： a. public 常量 b. public 变量 c. protect