项目命名规范

《网站后台管理系统命名规范》
注：本文中标注【规则-*】的条款必须严格执行，标注【建议-*】的条款为提倡采用。

1．JSP页面命名规则
【规则-1】大小写：所有文件的首字母小写；
【规则-2】命名：根据页面的功能，一般为业务名称+ 功
能；如：loginInof_edit.jsp，其中操作对象的
首字母小写；
【规则-2】常用的操作动作：
新增：_new
编辑：_edit
查看：_view
列表：_list
详细：_info
审批：_audit
确认：_confirm
查询：_query
注：各页面命名总体如此，要求意思表达完整。

2.包的命名（Package Names）
【规则-1】包名应该都用小写字母组成。

例如：dao/entity
包的命名：net.zzvc.szmt.aug
.dao实现类包含子包impl
.entity实体类
.common公共类，如时间函数
.biz业务类包含子包impl
.web包含子包Action，Form
.config配置文件
3.类和接口的命名（Class Names）
【规则-1】类名采用第一个字母大写其他字母小写的形式。

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

例如：Class UserDao
Action类均以类说明加*-Action形式；
例如：AdminAction
Form类均以类说明加*-Form形式；
例如：AdminForm
Biz类均以类说明加*-Biz形式；
例如：AdminBiz
Dao类均以类说明加*-Dao形式；
例如：AdminDao
【规则-3】接口的声明均以I开头以相应类声明规范形式结尾，如：IAdminDao、IAdminBiz。

4.变量的命名（Constant Names）
【规则-1】变量名应尽量使用对应英文或中文缩写，不能随便起名，影响编码人员编程。

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

例：MAX_SIZE
程序中应该使用常量代替“25”，“100”等实际
的数字，如：
//推荐
if (times == MAX_TIMES){
}
//避免
if (times == 25){
}
5.方法的命名（Methods Names）
【规则-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*;查询数据，比如：select User();
save*;保存新修改数据，效果跟insert方法一样；
比如：saveUser();
6.注释原则
【建议-1】在代码中尽量使用“//”风格的注释，而不提倡使用“/* ... */”的注释（除非注释比较多或有规范
要求的）。

这样可以允许使用“/* ... */”来把大范
围的代码转换为注释。

【规则-2】注释应当准确、易懂，防止有二义性。

错误的注
释不但无益反而有害
【规则-3】边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。

不再有用的注释要
及时删除。

【规则-4】注释是对代码逻辑的描述，而不是文档或代码的翻译。

程序中的注释不可喧宾夺主，注释太多了
会让人眼花缭乱。

【规则-5】类的注释：
a. 类是谁写的;
b. 类的功能有哪些；
c. 类的名称
如： /**
* 类名称
* 类的简要描述：
* @author ChenGangWei
*/
【规则-6】方法的注释：
a. 方法的功能说明。

行的注释：
a. 字段的名字必须用意义，字段必须有注释。

b. 重要的行必须有注释。

如： /**
* 方法名：
* 方法简要描述：
* 方法详细描述：（可选，有必要时写）
* @param参数：
* @return返回值：
*/
【规则-7】每一个代码“段”必须要有注释。

【规则-8】注释采用中文，尽量避免在注释中使用缩写，特别是不常用缩写。

7．数据库数据命名原则
【规则-1】表的命名：TBL_+表名；
【规则-2】表中的字段：表名的首字母+字段；字段名应尽量使用对应英文或中文缩写，不能随便起名，
影响编码人员编程。

8．JavaScript命名原则
a. function check+名称
如：非空验证checkIsNull
9．文件夹
自定义文件夹，字母全用小写；
例：存放css样式文件夹：css
存放图片文件夹：images
存放上传文件夹：uploads
存放js文件夹：js
总结：各设计规范应严格遵守，以保证项目顺利进行。

以上规范只是总的开发规范，之后都应以此为例来规范设
计，以便后续维护等。