编码规范目的:风格统一、代码可读性增强,便于维护
适用范围:J2EE项目,用SSH作为开发框架
一、包命名规范
1、servlet类所在包命名规范:公司名称.项目名称.web.servlet
如com.novots.mis.web.servlet
2、Action类所在包命名规范:公司名称.项目名称.web.struts.action
如com.novots.mis.web.action
3、Action类所在包命名规范:公司名称.名项目名称.web.form
如com.novots.mis.web.form
4、hibernate的bean类所在包命名规范:公司名称.名项目名称.bean
如com.novots.mis.bean
5、全局类所在包命名规范:公司名称.名项目名称.global
如com.novots.mis.global
6、dao层接口所在包命名规范:公司名称.名项目名称.dao
如com.novots.mis.dao
7、dao层接口实现类所在包命名规范:公司名称.名项目名称.dao.impl
如com.novots.mis.dao.impl
8、业务层接口所在包命名规范:公司名称.名项目名称.service
如com.novots.mis.service
9、业务层接口实现类所在包命名规范:公司名称.名项目名称.service.impl
如com.novots.mis.service.impl
二、类命名规范
1、以大写字母开头,多个单词每个单词开头字母大写
如DataFile
2、接口命名:以大写字母“I”开头
如IApplyImport
3、实现类命名:将接口的大写字母“I”去掉,加后缀“Impl”
如ApplyImportImpl
三、其它命名规范
1、变量命名:
变量名首字母必须小写,如果该变量名有多个单词组成,后面的单 词首字母大写,单词与单词之间不要使用"_"做连接,变量名访问控制必须为私有, 可以对其增加setter与getter方法。
2、常量命名:
所有字母大写,如果有多个单词组成,单词与单词之间以” _“隔开。而 且该变量必须是公共、静态、final类型
3、方法命名:
首字母必须小写,如果该变量名有多个单词组成,后面的单词首字母 大写,单词与单词之间不要使用"_"做连接。单词不要使用名词
四、项目组织
在项目组织上,分为文档和源文件进行管理
如Lims下有两个文件夹分别是“工作文档”和“code”。在“工作文档”下有“需求分析”、“系统设计”、“数据模型”、“系统原型”、“系统测试”、“部署发布”和“开发计划”等文档;在“code”下放源代码,对其进行版本控制。