项目命名规范.doc

文档介绍：《网站后台管理系统命名规范》

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

Ø 【规则-1】大小写:所有文件的首字母小写;
【规则-2】命名:根据页面的功能,一般为业务名称+ 功能;如:,其中操作对象的首字母小写;
Ø 【规则-2】常用的操作动作:
新增:_new
编辑:_edit
查看:_view
列表:_list
详细:_info
审批:_audit
确认:_confirm
查询:_query
注:各页面命名总体如此,要求意思表达完整。
(Package Names)
【规则-1】包名应该都用小写字母组成。
例如:dao/entity
.
.dao实现类包含子包impl
.entity实体类
.common公共类,如时间函数
.biz业务类包含子包impl
.web包含子包Action,Form
.config配置文件
(Class Names)
【规则-1】类名采用第一个字母大写其他字母小写的形式。
【规则-2】由多个单词组成的类名采用单词的第一个字母大写其他小写的形式。
例如: Class UserDao
Action类均以类说明加*-Action形式;
例如:AdminAction
Form类均以类说明加*-Form形式;
例如:AdminForm
Biz类均以类说明加*-Biz形式;
例如:AdminBiz
Dao类均以类说明加*-Dao形式;
例如:AdminDao
【规则-3】接口的声明均以I开头以相应类声明规范形式结尾,如:IAdminDao、IAdminBiz。
(Constant Names)
【规则-1】变量名应尽量使用对应英文或中文缩写,不能随便起名,影响编码人员编程。
【规则-2】构成名称的各单词均用大写,并且各单词之间用“_”分割。例:MAX_SIZE
程序中应该使用常量代替“25”,“100”等实际的数字,如:
//推荐
if (times == MAX_TIMES){
}
//避免
if (times == 25){
}
(Methods Names)
【规则-1】方法名以小写字母开头,以后每个单词的第一个字母大写,即驼峰命名法。
【规则-2】因为方法是在它所在的类的上下文中被调用的,所以没有必要在方法名中重复类的名字。例如类Customer中有一个方法可以提取顾客的名字,我们应该把这个方法命名为getName,而不是getCustomerName。当这个类的用户要调用此方法时,(),()。
【规则-3】当用一个方法调用同一个类或子类里的另一个方法时,需明确地使用“()”来强调你正在调用自己类里的方法。
【规则-4】命名:根据方法的功能命名。
get*;获取数据;比如:getAllUers();
find*;检索数据;比如:findUsersByID();
load*;载入数据;比