代码高级规范.doc

… HYPERLINK 46/wiki/pages/viewpage.action?pageId= java高级规范 Added by HYPERLINK 46/wiki/display/~0801_wangyuefeng89 \o 王岳峰, last edited by HYPERLINK 46/wiki/display/~0801_wangyuefeng89 \o 王岳峰 on 八月 06, 2009 ?( HYPERLINK 46/wiki/pages/diffpages.action?pageId=originalId= view change) Comment: 一：不允许使用汉语拼音命名??? 欠规范代码示例：??? public void zengJiaYongHu(){}? 拼音方法名称??? 规范代码示例:??? public void addUser(){}??? 解析：应当使用国际化语言，拼音使得代码难懂???二：Package名必须全部小写，尽量使用单个单词??? 欠规范代码示例：??????? com.lxit.daoImpl? 单词大写了,daoImpl多个单词??? 规范代码示例:??? com.lxit.dao.impl??? 解析：这是一个大家都认同的习惯写法，也是一个默认的规范???三：局部变量及输入参数不要与类成员变量同名(get/set方法与构造函数除外)??? 欠规范代码示例：??? public class UserDAOImpl{??? ??? private int count;??? ??? pubic void page(int count){}??? }??? 类字段和方法参数名相同??? 规范代码示例:??? ? public class UserDAOImpl{??? ??? private int count;??? ??? pubic void page(int pageCount){}??? ? }??? 解析：类变量会引起逻辑错误，引起覆盖。???四：尽量不要在变量后面加魔法数字,英文单个字母和没有实际意义的英文数字单词来区分变量??? 欠规范代码示例：??? ??? String One;? 命名一个英文数字的变量??? ??? User user1 = new User();??? ??? User user2 = new User();??? 规范代码示例:??? ?? User userAdd = new User();??? ?? User userUpdate = new User();??? 解析：这样会降低代码的可读性，并且不容易日后开发人员的维护???五：包，类，变量命名不要加下划线（常量除外）??? 欠规范代码示例：??? ?? com.tag_test.dao.jdbc_impl? 有下划线的包名??? ?? int user_age ;????????????? 带下划线的变量名??? ?? public class Class_ {}????? 带下划线的类名??? 规范代码示例:??? ?? com.tag.test.dao.jdbc.impl?? ??? int userAge ;??? ?? public class Classes {}??? 解析：一种习惯性的用法，默认的规范???六：常量命名要大写,单词之间要用下划线分开.??? 欠规范代码示例：??? ?public void static final String teamAdd = teamAdd;?? 小写且没有下划线??? 规范代码示例:??? ?public void static final String TEAM_ADD = teamAdd;??? 解析：容易区分变量和常量???七：方法名第一个字母小写（构造方法除外）.??? 欠规范代码示例：??? public void Function(){}? 大写的方法名??? 规范代码示例:??? public void function(){}??? 解析：习惯用法，默认的规范???八：两个单词以上的变量名要驼峰命名??? 欠规范代码示例：??? int userage;? age 单词a? 小写??? 欠规范代码示例：??? int userAge；??? 解析：能够更清晰的看懂变量所带代表的意思???九：每个变量要用看得懂的词语来描述，尽量不要省略.??? 欠规范代码示例：??? private Studeng stu ;? 把student 简写