JSPGen软件开发框架第四版 开发手册
以标准计算机英文为蓝本,杜绝拼音、或拼音英文混杂命名;
命名必须使他人能够快速理解其要表达的含义,避免使用生癖词汇、缩写过简的命名,遵循顾名思义原则。
A、包文件命名:由英文单词组成,均为小写字母;
B、类文件命名:遵守大驼峰命名法,所有单词首字母大写;
C、类中常量命名:所有字母一律大写,多个单词以下划线“_”间隔;
D、类中变量、属性、方法命名:均采用驼峰命名法,开头字母小写,其余单词首字母大写;
E、Web前端文件命名:所有字母一律小写,英文单词组成,单词间用下划线间隔(部分js文件除外);
F、数据库表及表字段命名:所有字母一律小写,英文单词组成,单词间用下划线间隔;
G、Dao、Service、Action文件命名:关键字加标识符命名,关键字按类文件命名定义,如:(以下以 * 代替关键字):
Dao文件:接口类按 *Dao形式命名,实现类按 *DaoImpl形式命名;
Service文件命名:接口类按 *Service形式命名,实现类按 *ServiceImpl形式命名;
Action文件命名:按 *Action形式命名,由表名或业务英文单词组成,简洁直观即可,如:*Action;
H、Action中方法命名(部分提示性定义):
判断方法、验证方法均以is开头;
返回Ajax时:按 *Ajax形式定义,如:isLoginAjax();
返回JSON时:按 *JSON形式定义,如:isLoginJSON();
注:关于Action文件,继承于Action文件(含派生的子Action文件)的类均称之为Action文件,目前包含两种类型:普通Action基类文件、可访问型Action文件。
普通Action基类文件:虽继承于Action文件,但命名无Action关键字,仅仅提供子类中的一些公共操作或对基础方法集中处理而已,文件中的公共方法不可通过地址访问规则进行调用;
可访问型Action文件:继承于其他Action文件或普通Action基类文件,但命名由*Action关键字组成,文件中的公共方法可通过地址访问规则进行调用。