项目开发规范Word格式文档下载.docx

项目开发规范Word格式文档下载.docx

《项目开发规范Word格式文档下载.docx》由会员分享，可在线阅读，更多相关《项目开发规范Word格式文档下载.docx（9页珍藏版）》请在冰豆网上搜索。

/head>

之间;

非特殊情况下JavaScript文件必须外链至页面底部;

引入样式文件或JavaScript文件时, 

须略去默认类型声明, 

写法如下:

ExampleSourceCode[]

<

link 

rel="

stylesheet"

href="

..."

style>

/style>

script 

src="

>

/script>

　　4. 

引入JS库文件, 

文件名须包含库名称（jQuery-1.6.js）　　

5. 

所有编码均遵循xhtml标准, 

标签 

&

属性 

属性命名 

必须由小写字母及下划线数字组成, 

且所有标签必须闭合, 

包括 

br 

（<

）, 

hr（<

hr 

）等;

属性值必须用双引号包括;

　　6. 

充分利用无兼容性问题的html自身标签, 

比如span, 

em, 

strong, 

optgroup, 

label,等等;

需要为html元素添加自定义属性的时候, 

首先 

要考虑下有没有默认的已有的合适标签去设置, 

如果没有, 

可以根据位置书写属性，譬如：

头部左侧可以为header_left，再如：

主体上部：

main_top等

7. 

如 

标题根据重要性用h*（同一页面只能有一个h1）, 

段落标记用p, 

列表用ul, 

内联元素中不可嵌套块级元素;

　　8. 

尽可能减少div嵌套, 

如

div 

class="

box"

<

welcome"

欢迎访问XXX, 

您的用 

户名是

name"

username<

/div>

完全可以用以下代码替代:

p>

欢迎 

访问XXX, 

您的用户名是<

span>

/span>

/p>

　　9. 

书写链接地址时, 

必须避免重定向，例如：

即须在URL地址后面加上“/”；

　　10. 

在页面中尽量避免使用style属性,即style="

…"

（行内样式）;

　　11. 

必须为含有描述性表单元素（input, 

textarea）添加label, 

姓 

名:

input 

type="

text"

id="

name="

须写成:

label 

for="

/label>

　　12. 

能以背景形式呈现的图片, 

尽量写入css样式中;

　　13. 

重要图片必须加上alt属性;

给重要的元素和截断的元素加上title;

　　14. 

给区块代码及重要功能（比如循环）加上注释, 

方便后台添加功能;

　　15. 

特殊符号使用:

尽可能使用代码替代:

比如 

） 

（>

空格（ 

»

（»

等等;

　　16. 

书写页面过程中, 

请考虑向后扩展性;

　　17. 

class 

id 

参见 

css书写规范.

5.css书写规范

编码统一为utf-8;

协作开发及分工:

项目经理会根据各个模块, 

同时根据页面相似程序, 

事先写好大体框架文件, 

分配给前端人员实现内部结构&

表现&

行为;

共用css文件base.css由项目经理书写, 

协作开发过程中, 

每个页面请务必都要引入, 

此文件包含reset及头部底部样式, 

此文件不可随意修改;

class与id的使用:

id是唯一的并是父级的, 

class是可以重复的并是子级的, 

所以id仅使用在大的模块上, 

class可用在重复使用率高及子级 

中;

id原则上都是由我分发框架文件时命名的, 

为JavaScript预留钩子的除外;

为JavaScript预留钩子的命名, 

请以 

js_ 

起始, 

比如:

js_hide, 

js_show;

　　5. 

class与id命名:

大的框架命名比如header/footer/wrapper/left/right之类的在2中由项目经理统一命名.其他样式名称由 

小写英文 

数 

字 

_ 

来组合命名, 

如main_comment, 

fontred, 

width200;

避免使用中文拼音, 

尽量使用简易的单词组合;

总之, 

命名要语义化, 

简明 

化.顾名思义

规避class与id命名

　　　　a, 

通过从属写法规避, 

示例见d;

　　　　b, 

取父级元素id/class命名部分命名, 

　　　　c, 

重复使用率高的命名, 

请以自己代号加下划线起始, 

比如i_clear;

　　　　d, 

a,b两条, 

适用于在2中已建好框架的页面, 

如, 

要在2中已建好框架的页面代码<

mainnav"

中加入新的div元 

素,

按a命名法则:

firstnav"

样式写法:

#mainnav 

.firstnav{.......}

按b命名法则:

main_firstnav"

.main_firstnav{.......}

　　7. 

css属性书写顺序, 

建议遵循:

布局定位属性-->

自身属性-->

文本属性-->

其他属性. 

此条可根据自身习惯书写, 

但尽量保证同类属 

性写在一起. 

属性列举:

布局定位属性主要包括:

display 

list-style 

position（相应 

的 

top,right,bottom,left） 

＆ 

float 

clear 

visibility 

overflow；

自身属性主要包括:

width 

height 

margin 

padding 

border 

background;

文本属性主要包括：

color 

font 

text-decoration 

text-align 

vertical-align 

white- 

space 

其他 

content;

我所列出的这些属性只是最常用到的, 

并不代表全部;

书写代码前, 

考虑并提高样式重复使用率;

充分利用html自身属性及样式继承原理减少代码量, 

ul 

list"

li>

这儿是标题列表<

2010-09- 

15<

/ul>

定义

ul.list 

li{position:

relative} 

li 

span{position:

absolute;

right:

0}

即可实现日期居右显示

样式表中中文字体名, 

请务必转码成unicode码, 

以避免编码错误时乱码;

杜绝使用<

http-equiv="

X-UA-Compatible"

content="

IE=7"

兼容 

ie8;

用png图片做图片时, 

要求图片格式为png-8格式,若png-8实在影响图片质量或其中有半透明效果, 

请为ie6单独定义背景:

_background:

none;

_filter:

progid:

DXImageTransform.Microsoft.AlphaImageLoader 

（sizingMethod=crop, 

src=’img/bg.png’）;

避免兼容性属性的使用, 

比如text-shadow 

|| 

css3的相关属性;

减少使用影响性能的属性, 

比如position:

absolute 

必须为大区块样式添加注释, 

小区块适量注释;

代码缩进与格式:

建议单行书写, 

可根据自身习惯, 

后期优化i会统一处理;

17.jsp重点注释一律使用<

%--注释内容--%>

6.JavaScript书写规范

文件编码统一为utf-8, 

书写过程过, 

每行代码结束必须有分号;

库引入:

原则上仅引入jQuery库, 

若需引入第三方库, 

须与团队其他人员讨论决定;

变量命名:

驼峰式命名. 

原生JavaScript变量要求是纯英文字母, 

首字母须小写, 

如iTaoLun;

jQuery变量要求首字符为'

_'

其他与原生JavaScript 

规则相同, 

如:

_iTaoLun;

另, 

要求变量集中声明, 

避免全局变量.

类命名:

首字母大写, 

ITaoLun;

函数命名:

首字母小写驼峰式命名. 

如iTaoLun（）;

命名语义化, 

尽可能利用英文单词或其缩写;

尽量避免使用存在兼容性及消耗资源的方法或属性, 

比如eval（） 

innerText;

后期优化中, 

JavaScript非注释类中文字符须转换成unicode编码使用, 

以避免编码错误时乱码显示;

代码结构明了, 

加适量注释. 

提高函数重用率;

注重与html分离, 

减小reflow, 

注重性能.

7.图片规范

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

图片格式不限制，但最好使用gif 

png 

jpg;

命名全部用小写英文字母 

数字 

的组合，其中不得包含汉字 

空格 

特殊字符；

尽量用易懂的词汇, 

便于团队其他成员理 

解;

命名分头尾两部分, 

用下划线隔开, 

比如ad_left01.gif 

btn_submit.gif;

在保证视觉效果的情况下选择最小的图片格式与图片质量, 

以减少加载时间;

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

8.注释规范

html注释:

注释格式 

--这儿是注释-->

'

--'

只能在注释的始末位置,不可置入注释文字区域;

2.jsp注释：

注释格式<

%--这儿是注释--%>

css注释:

/*这儿是注释*/;

JavaScript注释, 

单行注释使用'

//这儿是单行注释'

多行注释使用 

/* 

这儿有多行注释 

*/;

4.Java注释：

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

9.开发及测试工具约定

建议使用MyEclipse9及以上的版本开发 

亦可根据自己喜好选择, 

但须遵循如下原则:

不可利用IDE的视图模式'

画'

代码;

不可利用IDE生成相关功能代码, 

比如Dw内置的一些功能js;

编码必须格式化, 

比如缩进;

　　测试工具:

前期开发仅测试FireFox&

IE8&

IE9 

后期优化时加入Opera 

Chrome 

Safari;

　　建议测试顺序:

FireFox-->

IE7-->

IE9-->

IE8-->

Opera-->

Chrome-->

Safari, 

建议安装firebug或IE 

Tab 

Plus插件.

10.其他规范

开发过程中严格按分工完成页面, 

以提高css复用率, 

避免重复开发;

减小沉冗代码, 

书写所有人都可以看的懂的代码. 

简洁易懂是一种美德. 

为用户着想, 

为服务器着想.

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配置文件

bean

id=“和类名一致”

class=“对应的类”>

propertyname=“sessionFactory”>

<

refbean=“sessionFactory”/>

/property>

/bean>

例如：

以部门为例

id=“DeptDAO”

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

3、Struts配置文件

1、package

package

name=”功能模块名”

extends=”struts-default”

namespace=”/功能模块名”>

/package>

以订单为例

name=”indent”

namespace=”/indent”>

2、action

actionname=“和类名一致”class=”对应的类”>

/action>

以添加客户为例

action

name=“InsertCustomerAction”

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

3、result

result

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

type=“跳转的方式”>

跳转的位置

/result>

以登录为例

result

name=“SUCCESS”

type=“redirect”>

/index.jsp

注意：

type的常用值：

dispatcher转发页面，默认

redirect重定向页面

chain转发action

redirectAction重定向到action

4、完整事例

package

name=“customer”

extends=“struts-default”

namespace=“/customer”>

action

name=“InsertCustomerAction”

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

type=“redirect”>

/success.jsp