前端代码开发守则.docx
《前端代码开发守则.docx》由会员分享,可在线阅读,更多相关《前端代码开发守则.docx(10页珍藏版)》请在冰豆网上搜索。
前端代码开发守则
前端代码编写规范
一、规范目的
为提高团队协作效率,便于后台人员添加功能及前端后期优化维护,输出高质量的文档,特制订此文档。
本规范文档一经确认,前端开发人员必须按本文档规范进行前台页面开发。
本文档如有不对或者不合适的地方请及时提出,经讨论决定后方可更改。
二、基本准则
符合WEB标准,语义化HTML,结构化表现行为分离,代码兼容性优良。
页面性能方面,代码要求简洁明了有序,尽可能的减小服务器负载,保证最优最快的解析速度。
三、文件规范
1.Html,Css,Js,Images文件均归档至约定的目录中;目录命名尽可能使用英文,语义化,公用部分和各模块分开。
比如:
公用部分可放在comm目录文件夹下,各功能模块各建一个有意义的文件夹;
2.Html文件命名:
英文命名,整个网站统一后缀,不要同时出现shtml、shtm、html、htm;本规范采用“.html”。
同时将对应界面稿放于同目录中,若界面稿命名为中文,请重命名与html文件同名,以方便后端添加功能时查找对应页面;
3.css文件命名:
英文命名,后缀.css。
共用common.css,首页index.css,其他页面依实际模块需求命名;
4.Js文件命名:
英文命名,后缀.js。
共用common.js,其他依实际模块需求命名。
JS文件必须存入统一的JS目录文件夹;
四、HTML书写规范
1.文档类型声明及编码:
统一为html5声明类型
DOCTYPEhtml>;编码统一为,书写时利用IDE实现层次分明的缩进;
2.非特殊情况下样式文件必须外链至
3.引入样式文件或JavaScript文件时,须略去默认类型声明,写法如下:
4.所有编码均遵循xhtml标准,标签&属性&属性命名,必须由小写字母及下划线数字组成,且所有标签必须闭合,包括br(),hr(
5.充分利用无兼容性问题的html自身标签,比如span,em,strong,optgroup,label等等;需要为html元素添加自定义属性的时候,首先要考虑下有没有默认的已有的合适标签去设置,如果没有,可以使用须以”data-”为前缀来添加自定义属性,避免使用”data:
”等其他命名方式;
6.语义化html,如:
标题根据重要性用h*(同一页面只能有一个h1),段落标记用p,列表用ul,内联元素中不可嵌套块级元素;
7.尽可能减少div嵌套,如:
欢迎访问XXX,您的用户名是
用户名
完全可以用以下代码替代:
欢迎访问XXX,您的用户名是用户名
8.在页面中尽量避免使用style属性,即style=”…”;
9.必须为含有描述性表单元素(input,textarea)添加label,如:
姓名:
须写成:
10.能以背景形式呈现的图片,尽量写入css样式中;
11.重要图片必须加上alt属性;给重要的元素和截断的元素加上title;
12.给区块代码及重要功能(比如循环)加上注释,方便后台添加功能特殊符号使用:
尽可能使用代码替代:
比如<(<)&>(>)&空格()&?
(?
)等等;
13.书写页面过程中,请考虑向后扩展性;
14.class&id参见CSS书写规范.
五、CSS书写规范
1.编码统一为utf-8;
2.协作开发及分工:
<前端负责人>会根据各个功能模块,同时根据页面相似程序,事先写好大体框架文件,分配给前端人员实现内部结构&表现&行为;共用css文件Common.css由<前端负责人>编写,协作开发过程中,每个页面请务必都要引入,此文件包含【CSSReset(重设)】,如:
*{padding:
0;margin:
0;}及【头部底部样式】,此文件不可随意修改;
3.class与id的使用:
id是唯一的并是父级的,class是可以重复的并是子级的,所以id仅使用在大的模块上,class可用在重复使用率高及子级中;id原则上都是由<前端负责人>分发框架文件时命名的,为JavaScript预留接口ID的除外;
4.为JavaScript预留接口ID的命名,请以js_起始,比如:
js_hide,js_show;
5.class与id命名:
大的框架命名比如header/footer/wrapper/left/right之类的在2中由<前端负责人>统一命名。
其他样式名称由小写英文&数字&_来组合命名,如i_comment,fontred,width200;避免使用中文拼音,尽量使用简易的单词组合;总之,命名要语义化,简明化。
常用命名规则如:
【容器:
container/box】【头部:
header】【主导航:
mainNav】【子导航:
subNav】【顶导航:
topNav】【网站标志:
logo】【大广告:
banner】【页面中部:
mainBody】【底部:
footer】【菜单:
menu】【菜单内容:
menuContent】【子菜单:
subMenu】【子菜单内容:
subMenuContent】【搜索:
search】【搜索关键字:
keyword】【搜索范围:
range】【标签文字:
tagTitle】【标签内容:
tagContent】【当前标签:
tagCurrent/currentTag】【标题:
title】【内容:
content】【列表:
list】【当前位置:
currentPath】【侧边栏:
sidebar】【图标:
icon】【注释:
note】【登录:
login】【注册:
register】
6.规避class与id命名(此条重要,若有不明白请及时与<前端负责人>沟通):
A.通过从属写法规避,示例见D;
B.取父级元素id/class命名部分命名,示例见D;
C.重复使用率高的命名,请以自己代号加下划线起始,比如i_clear;
D.A,B两条,适用于在2中已建好框架的页面,如:
要在2中已建好框架的页面代码
中加入新的div元素:
按a命名法则:
…,
样式写法:
#mainnav.firstnav{…….}
按b命名法则:
.main_firstnav{…….}
7.css属性书写顺序,建议遵循:
布局定位属性>自身属性>文本属性>其他属性。
此条可根据自身习惯书写,但尽量保证同类属性写在一起。
属性列举:
A.布局定位属性主要包括:
【margin/padding/float/clear/position(相应的top,right,bottom,left)/display/visibility/overflow】等;
B.自身属性主要包括:
【width/height/margin/padding/background/border】
C.文本属性主要包括:
【font/color/text-align/text-decoration/text-indent/vertical-align/white-space】等;
D.其他属性包括:
【list-style(列表样式)/cursor/z-index(层叠顺序)/zoom】等。
E.CSS3属性:
transform/transition/animation/box-shadow/border-radius
F.如果使用CSS3的属性,如果有必要加入浏览器前缀,则按照-webkit-/-moz-/-ms-/-o-/std的顺序进行添加,标准属性写在最后。
G.链接的样式请严格按照如下顺序添加:
a:
link->a:
visited->a:
hover->a:
active
H.所列出的这些属性只是最常用到的,并不代表全部;
8.书写代码前,考虑并提高样式重复使用率;
9.充分利用html自身属性及样式继承原理减少代码量,比如:
这儿是标题列表2010-09-15
CSS定义:
ul.listli{position:
relative}ul.listlispan{position:
absolute;right:
0}
即可实现日期居右显示
10.样式表中中文字体名,请务必转码成unicode码,以避免编码错误时乱码
11.严格区分作为内容的图片和作为背景的图片。
作为背景的图片采用Csssprite技术,放在一张大图里。
Csssprite技术的优点是减少了http请求数,但使图片面向css的backround-position增加了耦合度,也增加了维护成本。
如果图片有修改,不要删除已添加的图片,在空白处新增修改后的图片,减少修改风险。
12.使用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;}tableth,tabletd{padding:
0;}
一般在公用的Common.css文件中进行初始化表格样式
13.杜绝使用兼容ie8;
14.用png图片做图片时,要求图片格式为png-8格式,若png-8实在影响图片质量或其中有半透明效果,请为ie6单独定义背景:
background:
15.避免兼容性属性的使用,比如:
text-shadow等css3的相关属性;
16.性能优化:
A.减少使用影响性能的属性,比如:
position:
absolute,float;
B.合并margin、padding、border的-left/-top/-right/-bottom的设置,尽量使用短名称。
C.选择器应该在满足功能的基础上尽量简短,减少选择器嵌套,查询消耗。
但是一定要避免覆盖全局样式设置。
D.注意选择器的性能,不要使用低性能的选择器。
E.禁止在css中使用*选择符。
F.除非必须,否则,一般有class或id的,不需要再写上元素对应的tag。
G.0后面不需要单位,比如0px可以省略成0,0.8px可以省略成.8px。
H.如果是16进制表示颜色,则颜色取值应该大写。
I.如果可以,颜色尽量用三位字符表示,例如#AABBCC写成#ABC。
J.如果没有边框时,不要写成border:
0,应该写成border:
none。
K.尽量避免使用AlphaImageLoader。
L.在保持代码解耦的前提下,尽量合并重复的样式。
M.background、font等可以缩写的属性,尽量使用缩写形式。
17.CSS注释;
每个CSS文件开头必须注释,如:
/*
*@description:
中文说明
*@author:
name作者
*@update:
name(2013-04-1318:
32)更新
*/
大区块必须注释,小区块适量注释,如:
/*Header*/
/*Footer*/
/*Gallery*/
18.代码缩进与格式:
建议单行书写,可根据自身习惯,后期优化i会统一处理;
六、JavaScript书写规范
1.文件编码统一为utf-8,书写过程过,每行代码结束必须有分号;原则上所有功能均根据XXX项目需求原生开发,以避免网上down下来的代码造成的代码污染(沉冗代码与现有代码冲突…);
2.库引入:
原则上仅引入jQuery库,若需引入第三方库,须与团队其他人员讨论决定;
3.变量命名:
驼峰式命名。
原生JavaScript变量要求是纯英文字母,首字母须小写,如iTaoLun;
4.jQuery变量要求首字符为‘_’,其他与原生JavaScript规则相同,如:
_iTaoLun;另注:
要求变量集中声明,避免全局变量。
5.类命名:
首字母大写,驼峰式命名。
如:
ITaoLun;
6.函数命名:
首字母小写驼峰式命名。
iTaoLun();
7.命名语义化,尽可能利用英文单词或其缩写;
8.尽量避免使用存在兼容性及消耗资源的方法或属性,比如:
eval()&innerText;
9.后期优化中,JavaScript非注释类中文字符须转换成unicode编码使用,以避免编码错误时乱码显示;
10.代码结构明了,加适量注释。
提高函数重用率;
11.注重与html分离,减小reflow,注重性能。
七、图片规范
1.所有页面元素类图片均放入img文件夹,测试用图片放于img/demoimg文件夹;
2.图片格式仅限于gif、png、jpg;
3.命名全部用小写【英文字母|数字|下划线】的组合,其中不得包含【汉字|空格|特殊字符】;尽量用易懂的词汇,便于团队其他成员理解;另注:
命名分头尾两部分,用下划线隔开,比如:
ad_left01.gif|btn_submit.png;
4.在保证视觉效果的情况下选择最小的图片格式与图片质量,以减少加载时间;
5.尽量避免使用半透明的png图片(若使用,请参考css规范相关说明);建议采用SVG或者iconfont技术;
6.运用csssprite技术集中小的背景图或图标,减小页面http请求,但注意,请务必在对应的spritepsd源图中划参考线,并保存至img目录下。
八、注释规范
1.html注释:
注释格式
–这儿是注释–>,“-”只能在注释的始末位置,不可置入注释文字区域;
2.css注释:
注释格式/*这儿是注释*/;
3.JavaScript注释,单行注释使用’//这儿是单行注释’,多行注释使用/*这儿有多行注释*/;
九、开发及测试工具约定
建议使用【Dw|Sublime|WebStorm|Notepad++|Vim|Aptana】等工具,亦可根据自己喜
好选择,但须遵循如下原则:
1.不可利用IDE的视图模式“画”代码;
2.不可利用IDE生成相关功能代码,比如Dw内置的一些功能js;
3.编码必须格式化,比如缩进;
测试工具:
前期开发仅测试Chrome,后期优化时加入FireFox|IE8|IE9|IE10|Opera(项目时间允许的话可加入Safari,Safari内核与Chrome相同);建议测试顺序:
Chrome->FireFox–>IE8–>IE9–>IE7–>Opera–>,建议安装firebug及IETabPlus插件.
一十、其他规范
1.开发过程中严格按分工完成页面,以提高css复用率,避免重复开发;
2.减小沉冗代码,书写所有人都可以看的懂的代码。
简洁易懂是一种美德。
去除没必要的代码,为用户着想,为服务器着想。
copyright@ 2008-2022 冰豆网网站版权所有
经营许可证编号:鄂ICP备2022015515号-1