《ShaingS系统--开发命名规范》由会员分享,可在线阅读,更多相关《ShaingS系统--开发命名规范(4页珍藏版)》请在金锄头文库上搜索。
1、ShaingS 系统 SSH 框架项目开发命名规范一、 各层包及类命名规范【驼峰命名法】就是当变量名或函式名是由一个或多个单字连结在一起,而构成的唯一识别字时,第一个单字以小写字母开始;第二个单字的首字母大写或每一个单字的首字母都采用大写字母。总体原则:包名所有字母小写,类名采用“驼峰标识” ,具体如下:1. Action(com.accp.action)类命名规范:模块名 + 后缀 Action 。如 UserAction2. DAO(com.accp.dao 层类命名规范:模块名 + 后缀 DAO。 (注意DAO 大写)如 UserDAO2. vo 层(com.accp.vo)类命名规范:
2、模块名如:User3. service 层(com.accp.service)类命名规范:模块名+Service如:UserService4. util 层公共类所在包命名规范:com.accp.util公共类命名规范:PageUtil二、配置文件命名规范总体原则:变量、属性、id 等均采用“驼峰标识” ,但首字母必须小写。1. struts.xml Action 命名规范:功能模块名,如 login/index.jsp/login.jsp /login.jsp2. applicationContext.xmlbean 命名规范:功能模块,如 userDAO3、css 样式表统一放在 WebR
3、oot-css 文件夹中js 文件统一放在 WebRoot-js 文件夹中图片文件统一放在 WebRoot-images 文件夹中模块文件夹,如登录模块,命名为 login,与登录相关的jsp 文件就放在 login 文件夹下, 目录登录结构参考如下:目录结构,以下作为参考:spring,struts,日志配置文件, 【注意:以下为主配置文件】模块配置文件:【比如说登录 login 模块的相关配置文件】三、其它命名规范1. 变量命名:变量名首字母必须小写,如果该变量名有多个单词组成,后面的单词首字母大写,单词与单词之间不要使用_做连接,变量名访问控制必须为私有, 可以对其增加 setter 与 getter 方法。2. 常量命名:所有字母大写,如果有多个单词组成,单词与单词之间以” _“隔开。而且该变量必须是公共、静态、final 类型 3. 方法命名:首字母必须小写,如果该变量名有多个单词组成,后面的单词首字母大写,单词与单词之间不要使用_做连接。单词不要使用名词4.jsp 文件命名“驼峰标识” ,且单词与单词之间不要使用_做连接。例如:addUser.jsp