项目开发规范.docx

定义

ul.list li{position:

relative}  ul.list li span{position:

absolute; right:

0}

即可实现日期居右显示

　　10. 样式表中中文字体名, 请务必转码成unicode码, 以避免编码错误时乱码;

　　11. 杜绝使用 兼容 ie8;

　　12. 用png图片做图片时, 要求图片格式为png-8格式,若png-8实在影响图片质量或其中有半透明效果, 请为ie6单独定义背景:

ExampleSourceCode[]

_background:

none;_filter:

progid:

DXImageTransform.Microsoft.AlphaImageLoader 

（sizingMethod=crop, src=’img/bg.png’）;

　　13. 避免兼容性属性的使用, 比如text-shadow || css3的相关属性;

　　14. 减少使用影响性能的属性, 比如position:

absolute || float ;

　　15. 必须为大区块样式添加注释, 小区块适量注释;

　　16. 代码缩进与格式:

 建议单行书写, 可根据自身习惯, 后期优化i会统一处理;

17.jsp重点注释一律使用<%--注释内容--%>

6.JavaScript书写规范

1. 文件编码统一为utf-8, 书写过程过, 每行代码结束必须有分号; 

　　2. 库引入:

 原则上仅引入jQuery库, 若需引入第三方库, 须与团队其他人员讨论决定;

　　3. 变量命名:

 驼峰式命名. 原生JavaScript变量要求是纯英文字母, 首字母须小写, 如iTaoLun;

ExampleSourceCode[]

jQuery变量要求首字符为'_', 其他与原生JavaScript 规则相同, 如:

 _iTaoLun;

另, 要求变量集中声明, 避免全局变量.

　　4. 类命名:

 首字母大写, 驼峰式命名. 如 ITaoLun;

　　5. 函数命名:

 首字母小写驼峰式命名. 如iTaoLun（）;

　　6. 命名语义化, 尽可能利用英文单词或其缩写;

　　7. 尽量避免使用存在兼容性及消耗资源的方法或属性, 比如eval（） & innerText;

　　8. 后期优化中, JavaScript非注释类中文字符须转换成unicode编码使用, 以避免编码错误时乱码显示;

　　9. 代码结构明了, 加适量注释. 提高函数重用率;

　　10. 注重与html分离, 减小reflow, 注重性能.

7.图片规范

1. 所有页面元素类图片均放入images文件夹

　　2. 图片格式不限制，但最好使用gif || png || jpg;

　　3. 命名全部用小写英文字母 || 数字 || _ 的组合，其中不得包含汉字 || 空格 || 特殊字符；尽量用易懂的词汇, 便于团队其他成员理 解; 另, 命名分头尾两部分, 用下划线隔开, 比如ad_left01.gif || btn_submit.gif;

　　4. 在保证视觉效果的情况下选择最小的图片格式与图片质量, 以减少加载时间;

　　5. 尽量避免使用半透明的png图片

8.注释规范

1. html注释:

 注释格式 

--这儿是注释-->, '--'只能在注释的始末位置,不可置入注释文字区域;

2.jsp注释：

注释格式<%--这儿是注释--%>

　　2. css注释:

 注释格式 /*这儿是注释*/;

　　3. JavaScript注释, 单行注释使用'//这儿是单行注释' ,多行注释使用 /* 这儿有多行注释 */;

4.Java注释：

类和方法均使用多行注释，方法内部使用当行注释

9.开发及测试工具约定

建议使用MyEclipse9及以上的版本开发 , 亦可根据自己喜好选择, 但须遵循如下原则:

　　1. 不可利用IDE的视图模式'画'代码;

　　2. 不可利用IDE生成相关功能代码, 比如Dw内置的一些功能js;

　　3. 编码必须格式化, 比如缩进;

　　测试工具:

 前期开发仅测试FireFox&IE8&IE9 , 后期优化时加入Opera & Chrome & Safari;

　　建议测试顺序:

 FireFox-->IE7-->IE9-->IE8-->Opera-->Chrome-->Safari, 建议安装firebug或IE Tab Plus插件.

10.其他规范

1. 开发过程中严格按分工完成页面, 以提高css复用率, 避免重复开发;

　　2. 减小沉冗代码, 书写所有人都可以看的懂的代码. 简洁易懂是一种美德. 为用户着想, 为服务器着想.

11.DIV+CSS命名规范

1.CSSID的命名

外　套：

　　container

主导航：

　　mainnav

子导航：

　　subnav

整个页面：

　content

页　眉：

　　header

页　脚：

　　footer

商　标：

　　label

标　题：

　　title

主导航：

　　mainbav（globalnav）

顶导航：

　　topnav

边导航：

　　sidebar

左导航：

　　leftsidebar

右导航：

　　rightsidebar

旗　志：

　　logo

标　语：

　　banner

菜单内容1：

menu1content

菜单容量：

　menucontainer

子菜单：

　　submenu

边导航图标：

sidebarIcon

注释：

　　　note

面包屑：

　　breadcrumb（即页面所处位置导航提示）

容器：

　　　container

内容：

　　　content

搜索：

　　　search

登陆：

　　　Login

功能区：

　　shop（如购物车，收银台）

当前的　　　current

2.另外在编辑样式表时可用的注释可这样写：

<--Footer-->

内容区

<--EndFooter-->

12、类名和方法名：

根据不同包、不同操作，给定不同的类名，如：

添加订单业务，应在service包下，名称应为InsertIndentService；

获得：

get****（获得最大的id——getMaxId）

查询：

query***（查询订单的所有信息——queryAllIndentInfo）

修改：

update***（修改当前状态——updateStatusById）

删除：

delete***（删除信息——deleteUserInfoById）

添加：

insert***（添加员工——insertEmpInfo）

在dao包中，应按照表名+dao（Usersdao）的命名规范

在vo包中，业务名称+VO（UserIndentVo——用户订单）

其他的包中类似，注：

类名首字母要大写，方法名首字母小写

13、文件存放

images——存放上传的图片（譬如新增产品时，需要上传产品的图片，则应以此目录为基准）在该文件下的文件用户存放一直保持不变的图片，即布局用的图片

css——样式

js——JavaScript脚本

view——jsp界面

在各文件夹中有模块的文件夹，将对应的文件放入对应的文件夹中

customer——存放客户模块的文件

order——存放订单功能模块的文件

staging——存放工作台功能模块的文件

14、配置文件

1、Hibernate配置文件

默认自动生成即可

注：

在Hibernate框架中的***.hbm.xml文件中的序列号，要自己添加

2、Spring配置文件

id=“和类名一致”

class=“对应的类”>

例如：

以部门为例

id=“DeptDAO”

class=“com.crm.dao.DeptDAO”>

3、Struts配置文件

1、package

name=”功能模块名”

extends=”struts-default”

namespace=”/功能模块名”>

例如：

以订单为例

name=”indent”

extends=”struts-default”

namespace=”/indent”>

2、action

例如：

以添加客户为例

name=“InsertCustomerAction”

class=“com.crm.action.InsertCustomerAction”>

3、result

name=“在action层中方法返回的String值”

type=“跳转的方式”>

跳转的位置

例如：

以登录为例

name=“SUCCESS”

type=“redirect”>

/index.jsp

注意：

type的常用值：

dispatcher转发页面，默认

redirect重定向页面

chain转发action

redirectAction重定向到action

4、完整事例

name=“customer”

extends=“struts-default”

namespace=“/customer”>

name=“InsertCustomerAction”

class=“com.crm.action.InsertCustomerAction”>

name=“SUCCESS”

type=“redirect”>

/success.jsp