V1.1项目命名规范

《V1.1项目命名规范》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、Struts2convention1、Action类名为XXXXAction必须实现action接口2、Result为全小写String字符串3、视图的存放位置为action类的报名的action后面部分。如包名为com.abc.action.admin,则视图的存放位置为/admin目录4、视图的书写为全小写，要写成ActionName-result.xxx,如action类为HelloWroldAction，返回值为“success”则视图为hello-world-successs.jsp5、定义struts视图的根目录为WebRoot（一般开始写程序的时候在st

2、ruts.xml中定义好就行了）。注：本文中标注【规则-*】的条款必须严格执行，标注【建议-*】的条款为提倡采用。1．JSP页面命名规则Ø【规则-1】大小写：所有文件的首字母小写；【规则-2】命名：根据页面的功能，一般为业务名称+功能；如：loginInfo_edit.jsp，其中操作对象的首字母小写；Ø【规则-2】常用的操作动作：新增：-new编辑：-edit查看：-view列表：-list详细：-info审批：-audit确认：-confirm查询：-query注：各页面命名总体如此，要求意思表达完整。2.包的命名（PackageNames）【规则-1】包名应该都

3、用小写字母组成。例如：dao/entity包的命名：net.zzvc.szmt.aug.dao实现类包含子包impl.model实体类.common公共类，如时间函数.service业务类包含子包impl.action包含子包Action，Form.config配置文件.util工具类3.类和接口的命名（ClassNames）【规则-1】类名采用第一个字母大写其他字母小写的形式。【规则-2】由多个单词组成的类名采用单词的第一个字母大写其他小写的形式。例如：ClassUserDaoAction类均以类说明加*-Action形式；例如：AdminActionForm类均以

4、类说明加*-Form形式；例如：AdminFormDao类均以类说明加*-Dao形式；例如：AdminDao【规则-3】接口的声明均以相应类声明规范形式结尾，如：AdminDao、AdminBiz(即是原型)。实现应该写成XXX+Impl，如AdminDaoImpl、AdminBizImpl。4.变量的命名（ConstantNames）【规则-1】变量名应尽量使用对应英文或中文缩写，不能随便起名，影响编码人员编程。【规则-2】构成名称的各单词均用大写，并且各单词之间用“_”分割。例：MAX_SIZE程序中应该使用常量代替“25”，“100”等实际的数字，如：//推荐i

5、f(times==MAX_TIMES){}//避免if(times==25){}【规则-3】常量用全大写！5.方法的命名（MethodsNames）【规则-1】方法名以小写字母开头，以后每个单词的第一个字母大写，即驼峰命名法。【规则-2】因为方法是在它所在的类的上下文中被调用的，所以没有必要在方法名中重复类的名字。例如类Customer中有一个方法可以提取顾客的名字，我们应该把这个方法命名为getName，而不是getCustomerName。当这个类的用户要调用此方法时，他们只需写customer.getName()，而不用写成重复的customer.getCust

6、omerName()。【规则-3】当用一个方法调用同一个类或子类里的另一个方法时，需明确地使用“this.methodName()”来强调你正在调用自己类里的方法。【规则-4】命名：根据方法的功能命名。get*;获取数据；比如：getAllUers();find*;检索数据；比如：findUsersByID();load*;载入数据；比如：loadUserByID();insert*;添加数据；比如：insertUser();delete*;删除数据，比如：deleteUser();update*;修改数据；比如：updateUser();select*;查询数据，比

7、如：selectUser();save*;保存新修改数据，效果跟insert方法一样；比如：saveUser();6.注释原则【建议-1】在代码中尽量使用“//”风格的注释，而不提倡使用“/*...*/”的注释（除非注释比较多或有规范要求的）。这样可以允许使用“/*...*/”来把大范围的代码转换为注释。【规则-2】注释应当准确、易懂，防止有二义性。错误的注释不但无益反而有害【规则-3】边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要及时删除。【规则-4】注释是对代码逻辑的描述，而不是文档或代码的翻译。程序中的注