信息技术有限公司代码开发规范.doc

xx信息技术有限公司

代码开发规范

xx信息技术有限公司
代码开发规范

一、项目：
IDE统一采用MyEclipse：
1. Tab policy设为“Spaces only”，Indentation size、Tab size均设为4
2. Maximum line width设为：140
3. java文件进行自动格式化
4. 项目编码utf-8

二、代码：
· 原则
1. 数据结构应该只有公共变量；对象应该只有私有变量和公有函数；
2. 一个类只做一类事、一个方法只做一件事
3. 类、方法尽量简单、短小
4. 宽度不超过140个字符
5. 方法不超过40行，基本一屏高度
6. 类不超过500行
7. 尽量用好的命名代替注释

· 基本
1. 统一采用log4j代替System.out.print、e.printStackTrace()等打印方式 
2. 流程语句必须用大括号
3. IO流必须用try finally关闭

· 命名
1. java基本命名规范
2. 类为名词、属性为名词、方法为动词(+名词)
3. 可以用2代替to，用4代替for，如string2int()
4. 命名不许相互包含，如：get()，getOne()
5. 不要采用getModel()、getModel1()、getModel2()数字方式命令

· 类型
1. 对象属性必须为类，不能用String代替Number、Date等，不能使用基本类型；
2. 方法参数、返回均不许为Map（除非dao层）
3. 泛型必须注明类型、不许使用List<Object>、List<?>（除非dao层参数）
4. 方法
5. 方法参数不能超过4个，可以拆分方法或用类封装参数
6. Collection对象迭代采用foreach方式

· 分层
1. action里只有跳转
2. service层只有业务逻辑

· jsp
1. 放到WEB-INF/jsp目录下，不许直接访问jsp
2. 不含java块、统一采用jstl
3. jsp不含style、script块
4. 采用css、js代码
5. 采用jQuery方式，监听事件，页面不含事件
6. 图片写好width、height属性

· dao层
1. 尽量采用预处理方式
2. sql语句必须大写
3. 一个dao类只操作一个Model
4. sql必须全部封装到dao层
三、版本控制

1. 不要上传自己的用户设置
2. 每次提交前先更新，解决冲突文件
3. 每次提交的代码必须保证没有错误，项目可以正常运行
4. 必须有提交信息，提交的格式为：<项目名> \n修改内容

4 / 4