项目命名规范



注：本文中标注【规则_*】的条款必须严格执行，标注【建议_*】的条款为提倡采用。

1．JSP页面命名规则

【规则_1】大小写：所有文件的首字母小写；

【规则_2】命名：根据页面的功能，一般为业务名称+功能；如：loginInfo_edit.jsp，其中操作对象的首字母小写；

【规则_3】常用的操作动作：

新增：_new

编辑：_edit

查看：_view

列表：_list

详细：_info

审批：_audit

确认：_confirm

查询：_query

注：各页面命名总体如此，要求意思表达完整。

2.包的命名（PackageNames）

【规则_1】包名应该都用小写字母组成。

例如： dao/entity

包的命名：com.smartlab

.dao 实现类包含子包impl

.entity 实体类

.utils工具类，如时间函数，连接数据库类

.biz业务类包含子包impl

.net通信类，主要涉及终端的通信

.config配置文件

3.类和接口的命名（ClassNames）

【规则_1】类名采用第一个字母大写其他字母小写的形式。

【规则_2】由多个单词组成的类名采用单词的第一个字母大写其他小写的形式。

例如：Class  UserDao

JavaBean类均以类说明形式； 例如：Admin

Utils类均以类说明加*+Utils形式； 例如：HibernateUtils

Biz类均以类说明加*+Biz形式； 例如：AdminBiz

Dao类均以类说明加*+Dao形式；例如：AdminDao

【规则_3】接口的声明均以I开头以相应类声明规范形式结尾， 如：IAdminDao、IAdminBiz。

4.变量的命名（ConstantNames）

【规则_1】变量名应尽量使用对应英文或中文缩写，不能随便起名，影响编码人员编程。

【规则_2】构成名称的各单词均用大写，并且各单词之间用“_”分割。例：MAX_SIZE

程序中应该使用常量代替“25”，“100”等实际的数字， 如：

//推荐 if(times==MAX_TIMES){}

//避免 if(times==25){}

5.方法的命名（MethodsNames）

【规则_1】方法名以小写字母开头，以后每个单词的第一个字母大写。

【规则_2】因为方法是在它所在的类的上下文中被调用的，所以没有必要在方法名中重复类的名字。例如类Customer中有一个方法可以提取顾客的名字，我们应该把这个方法命名为getName，而不是getCustomerName。当这个类的用户要调用此方法时，他们只需写customer.getName()，而不用写成重复的customer.getCustomerName()。

【规则_3】当用一个方法调用同一个类或子类里的另一个方法时，需明确地使用“this.methodName()”来强调你正在调用自己类里的方法。

【规则_4】命名：根据方法的功能命名。

get*; 获取数据； 比如：getAllUers();

find*;检索数据； 比如：findUsersByID();

load*;载入数据； 比如：loadUserByID();

insert*;添加数据；比如：insertUser();

delete*;删除数据，比如：deleteUser();

update*;修改数据；比如：updateUser();

select*;查询数据，比如：selectUser();

save*;保存新修改数据，效果跟insert方法一样；比如：saveUser();

6.注释原则

【建议_1】在代码中尽量使用“//”风格的注释，而不提倡使用“/*...*/”的注释（除非注释比较多或有规范要求的）。这样可以允许使用“/*...*/”来把大范围的代码转换为注释。

【规则_2】注释应当准确、易懂，防止有二义性。错误的注释不但无益反而有害。

【规则_3】边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要及时删除。

【规则_4】注释是对代码逻辑的描述，而不是文档或代码的翻译。程序中的注释不可喧宾夺主，注释太多了会让人眼花缭乱。【规则_5】类的注释： a. 类是谁写的;