《v1.1项目命名规范》由会员分享，可在线阅读，更多相关《v1.1项目命名规范（4页珍藏版）》请在金锄头文库上搜索。
1、Struts2 convention1、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（一般开始写
2、程序的时候在struts.xml 中定义好就行了） 。注：本文中标注【规则-*】的条款必须严格执行，标注【建议-*】的条款为提倡采用。1JSP 页面命名规则 【规则-1】大小写：所有文件的首字母小写；【规则-2】 命名：根据页面的功能，一般为业务名称 + 功能；如：loginInfo_edit.jsp，其中操作对象的首字母小写； 【规则-2】常用的操作动作：新增：-new编辑：-edit查看：-view列表：-list详细：-info审批：-audit确认：-confirm查询：-query注：各页面命名总体如此，要求意思表达完整。2.包的命名（Package Names）【规则-1】包名应该
3、都用小写字母组成。例如：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 形式；例如：AdminActionFo
4、rm 类均以类说明加*-Form 形式；例如：AdminFormDao 类均以类说明加*-Dao 形式；例如：AdminDao【规则-3】接口的声明均以相应类声明规范形式结尾，如：AdminDao、AdminBiz(即是原型)。实现应该写成 XXX+Impl，如AdminDaoImpl、AdminBizImpl。4.变量的命名（Constant Names）【规则-1】变量名应尽量使用对应英文或中文缩写，不能随便起名，影响编码人员编程。【规则-2】构成名称的各单词均用大写，并且各单词之间用“_”分割。例：MAX_SIZE程序中应该使用常量代替“25” ， “100”等实际的数字，如：/推荐if
5、 (times = MAX_TIMES)/避免if (times = 25)【规则-3】常量用全大写！5.方法的命名（Methods Names）【规则-1】方法名以小写字母开头，以后每个单词的第一个字母大写，即驼峰命名法。【规则-2】因为方法是在它所在的类的上下文中被调用的，所以没有必要在方法名中重复类的名字。例如类 Customer 中有一个方法可以提取顾客的名字，我们应该把这个方法命名为 getName，而不是getCustomerName。当这个类的用户要调用此方法时，他们只需写customer.getName()，而不用写成重复的customer.getCustomerName()。
6、【规则-3】当用一个方法调用同一个类或子类里的另一个方法时，需明确地使用“this.methodName()”来强调你正在调用自己类里的方法。【规则-4】命名：根据方法的功能命名。get*;获取数据；比如：getAllUers();find*;检索数据；比如：findUsersByID();load*;载入数据；比如：loadUserByID();insert*;添加数据；比如：insertUser();delete*;删除数据，比如：deleteUser();update*;修改数据；比如：updateUser();select*;查询数据，比如：select User();save*;保存
7、新修改数据，效果跟 insert 方法一样；比如：saveUser();6.注释原则【建议-1】在代码中尽量使用“/”风格的注释，而不提倡使用“/* . */”的注释（除非注释比较多或有规范要求的） 。这样可以允许使用“/* . */”来把大范围的代码转换为注释。【规则-2】注释应当准确、易懂，防止有二义性。错误的注释不但无益反而有害【规则-3】边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要及时删除。【规则-4】注释是对代码逻辑的描述，而不是文档或代码的翻译。程序中的注释不可喧宾夺主，注释太多了会让人眼花缭乱。【规则-5】类的注释：a. 类是谁写的;b.
8、 类的功能有哪些；c. 类的名称如： /* 类名称* 类的简要描述：* author ChenGangWei*/【规则-6】方法的注释：a. 方法的功能说明。行的注释：a. 字段的名字必须用意义，字段必须有注释。b. 重要的行必须有注释。如： /* 方 法 名：* 方法简要描述：* 方法详细描述：（可选，有必要时写）* param 参数：* return 返回值：*/【规则-7】每一个代码“段”必须要有注释。【规则-8】注释采用中文，尽量避免在注释中使用缩写，特别是不常用缩写。7数据库数据命名原则【规则-1】 表的命名：T_+表名；【规则-2】 表中的字段：表名的首字母+字段；字段名应尽量使用对应英文或中文缩写，不能随便起名，影响编码人员编程。8JavaScript 命名原则a. function check+名称 如：非空验证 checkIsNull9文件夹自定义文件夹，字母全用小写；例：存放css样式文件夹：css存放图片文件夹：images存放上传文件夹：uploads存放 js 文件夹：js总结：各设计规范应严格遵守，以保证项目顺利进行。以上规范只是总的开发规范，之后都应以此为例来规范设计，以便后续维护等。
