Java编程标准规范.docVIP

Java编码规范 制订本编程格式目标是为了使软件可读性好、兼容性好、易维护等等。 注：加（*）者为关键确保要求。 一、命名规范 1.1 Package 命名(*) Package 名字应由一个小写单词组成。为了确保包唯一性，通常以企业国际域名开头。 比如：com.elanbase.db。 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) /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.elanbase.db.DbAccess 2.4 Class Fields 类组员变量： /** * Packet counters */ protected int[] packets; public 组员变量必需以生成文档（JavaDoc）方法进行注释（/** … */）。protected、 private 和package 定义组员变量假如名字含义明确话，能够没有注释。 Field 定义可遵从以下次序： a. public 常量 b. public 变量 c. protected 常量 d. protected 变量 e. package 常量 f.