V1.1项目命名规范.doc

Struts2 convention 1、Action类名为XXXXAction 必须实现action接口 2、Result为全小写String字符串 3、视图的存放位置为action类的报名的action后面部分。如包名为com.abc.action.admin,则视图的存放位置为/admin目录 4、视图的书写为全小写，要写成ActionName-result.xxx,如action类为HelloWroldAction，返回值为“success”则视图为hello-world-successs.jsp 5、定义struts视图的根目录为WebRoot（一般开始写程序的时候在struts.xml中定义好就行了）。 注：本文中标注【规则-*】的条款必须严格执行，标注【建议-*】的条款为提倡采用。 1．JSP页面命名规则 ? 【规则-1】大小写：所有文件的首字母小写； 【规则-2】 命名：根据页面的功能，一般为业务名称 + 功能；如：loginInfo_edit.jsp，其中操作对象的首字母小写； ? 【规则-2】常用的操作动作： 新增：-new 编辑：-edit 查看：-view 列表：-list 详细：-info 审批：-audit 确认：-confirm 查询：-query 注：各页面命名总体如此，要求意思表达完整。 2.包的命名（Package Names） 【规则-1】包名应该都用小写字母组成。 例如：dao/entity 包的命名：net.zzvc.szmt.aug .dao实现类包含子包impl .model实体类 .common公共类，如时间函数 .service业务类包含子包impl .action包含子包Action，Form .config配置文件 .util 工具类 3.类和接口的命名（Class Names） 【规则-1】类名采用第一个字母大写其他字母小写的形式。 【规则-2】由多个单词组成的类名采用单词的第一个字母大写其他小写的形式。 例如： Class UserDao Action类均以类说明加*-Action形式； 例如：AdminAction Form类均以类说明加*-Form形式； 例如：AdminForm Dao类均以类说明加*-Dao形式； 例如：AdminDao 【规则-3】接口的声明均以相应类声明规范形式结尾，如：AdminDao、AdminBiz(即是原型)。实现应该写成XXX+Impl，如AdminDaoImpl、AdminBizImpl。 4.变量的命名（Constant Names） 【规则-1】变量名应尽量使用对应英文或中文缩写，不能随便起名，影响编码人员编程。 【规则-2】构成名称的各单词均用大写，并且各单词之间用“_”分割。例：MAX_SIZE 程序中应该使用常量代替“25”，“100”等实际的数字，如： //推荐 if (times == MAX_TIMES){ } //避免 if (times == 25){ } 【规则-3】常量用全大写！ 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】在代码中尽量使用“//”风格的注释，而不提倡使用“/* ... */”的注释（除非注释比较多或有规范