web前端规范.docx

样式写法:

  .main_firstnav{…….}

7. css属性书写顺序, 建议遵循 布局定位属性–>自身属性–>文本属性–>其他属性. 此条可根据自身习惯书写, 但尽量保证同类属性写在一起. 属性列举:

 布局定位属性主要包括:

 margin　＆　padding　＆　float（包括clear）　＆　position（相应的 top,right,bottom,left）　＆　display　＆　visibility　＆　overflow等；

 自身属性主要包括:

 width & height & background & border; 

文本属性主要包括：

　font　＆　color　＆　text-align　＆　text-decoration　＆　text-indent等；

其他属性包括:

list-style（列表样式）　＆　vertical-align　＆　cursor　＆　z-index（层叠顺序） 　＆　zoom等. 我所列出的这些属性只是最常用到的, 并不代表全部;

8. 书写代码前, 考虑并提高样式重复使用率;

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

定义

ul.list li{position:

relative} 

 ul.list li span{position:

absolute; right:

0}

即可实现日期居右显示

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

11. 使用table标签时（尽量避免使用table标签）, 请不要用width/ height/cellspacing/cellpadding等table属性直接定义表现, 应尽可能的利用table自身私有属性分离结构与表现, 如thead,tr,th,td,tbody,tfoot,colgroup,scope; 

（cellspaing及cellpadding的css控制方法:

 table{border:

0;margin:

0;border-collapse:

collapse;} 

table th, table td{padding:

0;} , base.css文件中我会初始化表格样式）

12. 杜绝使用 兼容ie8;

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

_background:

none;_filter:

progid:

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

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

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

absolute || float ;

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

17. 代码缩进与格式:

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

JavaScript书写规范

1. 文件编码统一为utf-8, 书写过程过, 每行代码结束必须有分号; 原则上所有功能均根据XXX项目需求原生开发, 以避免网上下载下来的代码造成的代码污染（沉冗代码 || 与现有代码冲突 || …）;

2. 库引入:

 原则上仅引入jQuery库, （要与后台统一版本，需要与后台商量，或者由老师规定版本）若需引入第三方库, 须与团队其他人员讨论决定;

3. 变量命名:

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

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

 _iTaoLun;

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

4. 类命名:

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

5. 函数命名:

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

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

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

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

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

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

图片规范

1. 所有页面元素类图片均放入img文件夹, 测试用图片放于img/demoimg文件夹;

2. 图片格式仅限于gif || png || jpg;

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

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

5. 尽量避免使用半透明的png图片（若使用, 请参考css规范相关说明），透明的图片除外;

注释规范

1. html注释:

 注释格式 

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

2. css注释:

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

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

开发及测试工具约定

建议使用Aptana || Dw || Vim||HBuilder , 亦可根据自己喜好选择, 但须遵循如下原则:

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

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

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

测试工具:

 前期开发仅测试FireFox & IE6 & IE7 & IE8 , 后期优化时加入Opera & Chrome（项目时间允许的话可加入Safari,Safari内核与Chrome相同）;

建议测试顺序:

 FireFox–>IE7–>IE8–>IE6–>Opera–>Chrome, 建议安装firebug及IE Tab Plus插件.

其他规范

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

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