《java程序编码规范》由会员分享，可在线阅读，更多相关《java程序编码规范（10页珍藏版）》请在金锄头文库上搜索。
1、JAVA程序编码规范1变量的命名规则1.1 常量(包含静态的)一个或多个英文单词的组合，所有字母均大写，单词之间以“_”分隔，如：public static final String PLATFORM_NAME = “CSSCIS“final double PI = 3.14d；一般情况下常量的public等修饰符不可少。1.2 类变量（静态变量）及实例变量一个或多个英文单词的组合，第一个单词的首字母小写，其他单词首字母均大写，其余所有字母均小写。如:private DesktopItem desktopItem;private static String providerUrl = “htt
2、p:/localhost/web/sm/login.ext“;private Logger loger = Logging.getLogger(“TestLogger“); 一般情况下类变量（静态变量）及实例变量的public等修饰符不可少。1.3 局部变量一个或多个英文单词的组合，一般采用Hungaryn naming法（匈牙利定义法），如下：以下是基本数据类型的前缀列表前缀含义实例ch表示char类型char chTemp;i表示int类型int iNumber;前缀含义实例byte表示Byte类型Byte byteGet;s表示short类型Short sNumber;l表示long类型
3、long lNumber;f表示float类型Float fCount;d表示double类型double dPrise;str表示String类型String strSend;b表示boolean类型Boolean bFlag;其他数据类型的前缀列表前缀含义实例Collection colUser = new ArrayList();col表示Collection类型Collection colUser = new Vector();al表示ArrayList类型ArrayList alUser = new ArrayList();date表示Date类型Date dateStart = n
4、ew Date();sb表示StringBuffer类型StringBuffer sbName= new StringBuffer(1024)除上述情况以外的数据类型，都以obj作为前缀，后面跟一个能说明变量功能或意义单词作为变量，如：User objUser;1.4 参数一个或多个英文单词的组合，第一个单词的首字母小写，其他单词首字母均大写，其余所有字母均小写。如:public void setUser(User user) public void setUserId(String userId)建议方法的参数不要超过5个，超过时可以将多个参数合并为一个对象进行传递。1.5 其它常用数据类型
5、的变量，采用固定的命名，包括以下几种:Connection conn；ResultSet rs；PreparedStatement pstmt；Statement stmt；数组变量命名与普通变量命名规则一致，一般在具体的英文单词复数形式如：int projectIds;public String userNames;每个变量的声明单独占一行。不能一个类型同时声明两个变量。如：int i, j; 这样的写法是不允许的。不要在代码中出现不使用的变量，如果以后会用到或有其他用途要写上注释说明。2方法的命名规则方法命名的基本原则：容易看懂一般的方法名采用两个单词动宾结构形式的名称，两个单词之间不要带
6、其它符号，第二个单词的首字母大写，其它的都小写。如：readBudget(int budgetId)、deleteBudget(int budgetId)只有一个动词形式的方法名不推荐使用。不容易看明白的方法名或有歧义的方法名可采用多单词的形式，每两个单词之间不要带其它符号，从第二个单词开始，每个单词的首字母大写，其它的都小写。如：readBudgetByProjectId(int projectId)、readBudgetByProjectIdAndYear(int projectId,int year)方法命名不得采用缩写形式。3类及接口的命名规则3.1 一般类名一个或多个英文单词的组合，
7、所有单词的首字母大写，其余所有字母均小写，如：public class User 3.2 实体对象一般采用工具自动生成，名字为数据库表的逻辑名，如：表SM_USER的实体对象名为SmUser。3.3 数据访问接口及类(Dao)一般采用实体对象名+Dao来命名接口，实体对象名+DaoImpl来命名类3.4 服务接口及类(Service)一般采用实体对象名+Service来命名接口，实体对象名+ServiceImpl来命名类3.5 控制器类(Controller)一般采用实体对象名+Controller来命名4作用域4.1 类的作用域类的作用域保持最小范围。供包外其它类引用的类才添加public作
8、用域修饰符。4.2 方法的作用域只供对象或类内部调用的方法必须使用private作用域修饰符。包外不会调用的方法严禁使用public作用域修饰符。4.3 属性的作用域静态常量（类常量）属性可以使用各种作用域修饰符。对象属性变量严禁使用public作用域修饰符。实体对象属性变量必须使用private作用域修饰符。4.4 局部变量的作用域方法内的变量定义应该遵循最小作用域规则。如：/ iSize只在下面的for循环中使用Int iSize = alItems.size();for(int i=0;i”。如下:/* 系统管理用户维护实现类.实现新增项目,删除用户等方法，* 提供对表现层Control
9、ler使用的接口.* author 张三* since JDK1.5*/类中必要的方法(包括私有方法)要写方法头注释。其中返回值(return)需要说明含义,包括整型,布尔型,集合等,如对于整形：return 返回1表示成功，0表失败；对于集合类型要写明集合内元素的类型：return UserVO的集合。如果注释的内容比较长则需要加“”，如下：/* 修改用户信息* param user 用户信息* throws NoPermissionException 没有修改权限* return 修改成功返回1 没有修改返回0*/public int updateUser(User user) throw
10、s NoPermissionException对代码块的注释，注释语句放在代码块之上，用”/”进行注释，如果注释语句本身超过一行，则用”/* */”进行注释。对某一行代码的注释，注释语句放在代码行的后面，用”/”进行注释。建议代码块之间空一行。如下：public void insertUser(User user) / 新增用户service.save(user);/*增加到默认用户组*/. 6格式6.1 缩进设定为4 个字符。6.2 每代码行的长度代码行的长度不超过100个字符。6.3 大括号大括号中的“”与条件在同一行，“”单独一行，即使大括号中只有一条执行语句也要使用大括号，如：if (
11、a = b) return 0 ;6.4 空行类文件头注释、package语句、import语句、类头注释、类的属性、方法等之间都空一行。类的属性与属性之间、方法与方法之间都空一行。如下：/* Copyright (C) 2008 ShenZhen Csscis Information Technology Co.,Ltd* All Rights Reserved.*/package com.csscis.platform.core.util;import mon.*;/* 类说明.* author 张三* since JDK1.5* history 2005-03-15 张三 新建*/pub
12、lic class ProjectException extends BaseException private String message;/*. .*/public ProjectException(String message) super(message);this.message = message;/*. .*/public String getMessage() return message;6.5 空格“=”、“+”、“=”等二元操作符两边分别空一格。如：int i = 1;“，”的后面空一格。如：implements Runnable, cloneable6.6 import部分import引用要具体到类名，不能用“*”。import语句书写的顺序为：Java标准类，第三方软件类库，本公司自己的组件类、本工程其他包中的类。这四部分之间分别空一行。所有需要用到的其他包的类都要在import中应用，不要将类似“new java.util.ArrayList()”的语句写在代码中。6.7 数字long、double、float型变量后的字母“L”、“D”、“F”均大写。16进制的前缀“0X”要大写“X”，数字部分“A”
