程序编码规范_2.docVIP

JAVA程序编码规范 变量的命名规则 常量(包含静态的) 一个或多个英文单词的组合，所有字母均大写，单词之间以“_”分隔，如： public static final String PLATFORM_NAME = CSSCIS final double PI = 3.14d； 一般情况下常量的public等修饰符不可少。 类变量（静态变量）及实例变量 一个或多个英文单词的组合，第一个单词的首字母小写，其他单词首字母均大写，其余所有字母均小写。如: private DesktopItem desktopItem; private static String providerUrl = http://localhost/web/sm/login.ext; private Logger loger = Logging.getLogger(TestLogger); 一般情况下类变量（静态变量）及实例变量的public等修饰符不可少。 局部变量 一个或多个英文单词的组合，一般采用Hungaryn naming法（匈牙利定义法），如下： 以下是基本数据类型的前缀列表 前缀 含义 实例 ch 表示char类型 char chTemp; i 表示int类型 int iNumber; byte 表示Byte类型 Byte byteGet; s 表示short类型 Short sNumber; l 表示long类型 long lNumber; f 表示float类型 Float fCount; d 表示double类型 double dPrise; str 表示String类型 String strSend; b 表示boolean类型 Boolean bFlag; 其他数据类型的前缀列表 前缀 含义 实例 col 表示Collection类型 Collection colUser = new ArrayList(); Collection colUser = new Vector(); al 表示ArrayList类型 ArrayList alUser = new ArrayList(); date 表示Date类型 Date dateStart = new Date(); sb 表示StringBuffer类型 StringBuffer sbName= new StringBuffer(1024) 除上述情况以外的数据类型，都以obj作为前缀，后面跟一个能说明变量功能或意义单词作为变量，如： User objUser; 参数 一个或多个英文单词的组合，第一个单词的首字母小写，其他单词首字母均大写，其余所有字母均小写。如: public void setUser(User user) public void setUserId(String userId) 建议方法的参数不要超过5个，超过时可以将多个参数合并为一个对象进行传递。 其它 常用数据类型的变量，采用固定的命名，包括以下几种: Connection conn； ResultSet rs； PreparedStatement pstmt； Statement stmt； 数组变量命名与普通变量命名规则一致，一般在具体的英文单词复数形式如： int projectIds[]; public String userNames[]; 每个变量的声明单独占一行。不能一个类型同时声明两个变量。如：int i, j; 这样的写法是不允许的。 不要在代码中出现不使用的变量，如果以后会用到或有其他用途要写上注释说明。 方法的命名规则 方法命名的基本原则：容易看懂 一般的方法名采用两个单词动宾结构形式的名称，两个单词之间不要带其它符号，第二个单词的首字母大写，其它的都小写。 如：readBudget(int budgetId)、deleteBudget(int budgetId) 只有一个动词形式的方法名不推荐使用。 不容易看明白的方法名或有歧义的方法名可采用多单词的形式，每两个单词之间不要带其它符号，从第二个单词开始，每个单词的首字母大写，其它的都小写。 如：readBudgetByProjectId(int projectId)、readBudgetByProjectIdAndYear(int projectId,int year) 方法命名不得采用缩写形式。 类及接口的命名规则 一般类名 一个或多个英文单词的组合，所有单词的首字母大写，其余所有字母均小写，如： public class User { } 实体对象 一般采用工具自动生成，名字为数据库表的逻辑名，如： 表SM_USER的实体对象名为SmUser。 数据访问接口及类(Dao)