该【前端代码开发规范 】是由【leng_001】上传分享，文档一共【11】页，该文档可以免费在线阅读，需要了解更多关于【前端代码开发规范 】的内容，可以使用淘豆网的站内搜索功能，选择自己适合的文档，以下文字是截取该文章内的部分文字，如需要获得完整电子版，请下载此文档到您的设备，方便您编辑和打印。前端代码编写规范
规范目的
为提高团队协作效率,便于后台人员添加功能及前端后期优化维护,输出高质量的文档,特制订此文档;
本规范文档一经确认,前端开发人员必须按本文档规范进行前台页面开发;
本文档如有不对或者不合适的地方请及时提出,经讨论决定后方可更改;
基本准则
符合WEB标准,语义化HTML,结构化表现行为分离,代码兼容性优良;
页面性能方面,代码要求简洁明了有序,尽可能的减小服务器负载,保证最优最快的解析速度;
文件规范
Html,Css,Js,Images文件均归档至约定的目录中;目录命名尽可能使用英文,语义化,公用部分和各模块分开;比如:公用部分可放在comm目录文件夹下,各功能模块各建一个有意义的文件夹;
Html文件命名:英文命名,整个网站统一后缀,不要同时出现shtml、shtm、html、htm;本规范采用“.html”;同时将对应界面稿放于同目录中,若界面稿命名为中文,请重命名与html文件同名,以方便后端添加功能时查找对应页面;
css文件命名:英文命名,;共用,首页,其他页面依实际模块需求命名;
Js文件命名:英文命名,;共用,其他依实际模块需求命名;JS文件必须存入统一的JS目录文件夹;
HTML书写规范
文档类型声明及编码:统一为html5声明类型<DOCTYPEhtml>;编码统一为<metacharset=”utf-8″/>,书写时利用IDE实现层次分明的缩进;
非特殊情况下样式文件必须外链至<head>…</head>之间;非特殊情况下JavaScript文件必须外链至页面底部;
引入样式文件或JavaScript文件时,须略去默认类型声明,写法如下:
<link rel=”stylesheet”href=”…”/>
<style>…</style>
<script src=”…”></script>
引入JS库文件,文件名须包含库名称及版本号及是否为压缩版,比如引入插件,文件名格式为库名称+插件名称,比如所有编码均遵循xhtml标准,标签&属性&属性命名,必须由小写字母及下划线数字组成,且所有标签必须闭合,包括br<br/>,hr<hr/>等;属性值必须用双引号包括;所有标签和属性名称都必须小写;
充分利用无兼容性问题的html自身标签,比如span,em,strong,optgroup,label等等;需要为html元素添加自定义属性的时候,首先要考虑下有没有默认的已有的合适标签去设置,如果没有,可以使用须以”data-”为前缀来添加自定义属性,避免使用”data:”等其他命名方式;
语义化html,如:标题根据重要性用h同一页面只能有一个h1,段落标记用p,列表用ul,内联元素中不可嵌套块级元素;
尽可能减少div嵌套,如:
<divclass=”box”>
<divclass=”welcome”>欢迎访问XXX,您的用户名是
<divclass=”name”>用户名</div>
</div>
</div>
完全可以用以下代码替代:
<divclass=”box”>
<p>欢迎访问XXX,您的用户名是<span>用户名</span></p>
</div>
书写链接地址时,必须避免重定向,例如:href=,即须在URL地址后面加上“/”;
在页面中尽量避免使用style属性,即style=”…”;
必须为含有描述性表单元素input,textarea添加label,如:
<p>姓名:<inputtype=”text”id=”name”name=”name”/></p>
须写成:
<p><labelfor=”name”>姓名:</label><inputtype=”text”id=”name”/></p>
能以背景形式呈现的图片,尽量写入css样式中;
重要图片必须加上alt属性;给重要的元素和截断的元素加上title;
给区块代码及重要功能比如循环加上注释,方便后台添加功能特殊符号使用:尽可能使用代码替代:比如<<&>>&空格&等等;
书写页面过程中,请考虑向后扩展性;
class&id参见CSS书写规范.
CSS书写规范
编码统一为utf-8;
协作开发及分工:<前端负责人>会根据各个功能模块,同时根据页面相似程序,事先写好大体框架文件,分配给前端人员实现内部结构&表现&行为;共用css文件由<前端负责人>编写,协作开发过程中,每个页面请务必都要引入,此文件包含CSSReset重设,如:{padding:0;margin:0;}及头部底部样式,此文件不可随意修改;
class与id的使用:id是唯一的并是父级的,class是可以重复的并是子级的,所以id仅使用在大的模块上,class可用在重复使用率高及子级中;id原则上都是由<前端负责人>分发框架文件时命名的,为JavaScript预留接口ID的除外;
为JavaScript预留接口ID的命名,请以js_起始,比如:js_hide,js_show;
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
规避class与id命名此条重要,若有不明白请及时与<前端负责人>沟通:
通过从属写法规避,示例见D;
取父级元素id/class命名部分命名,示例见D;
重复使用率高的命名,请以自己代号加下划线起始,比如i_clear;
A,B两条,适用于在2中已建好框架的页面,如:要在2中已建好框架的页面代码
<divid=”mainnav”></div>中加入新的div元素:
按a命名法则:<divid=”mainnav”><divclass=”firstnav”>…</div></div>,
样式写法:
{…….}
按b命名法则:<divid=”mainnav”><divclass=”main_firstnav”>…</div></div>,
样式写法:
.main_firstnav{…….}
css属性书写顺序,建议遵循:布局定位属性>自身属性>文本属性>其他属性;此条可根据自身习惯书写,但尽量保证同类属性写在一起;属性列举:
布局定位属性主要包括:margin/padding/float/clear/position相应的top,right,bottom,left/display/visibility/overflow等;
自身属性主要包括:width/height/margin/padding/background/border
文本属性主要包括:font/color/text-align/text-decoration/text-indent/vertical-align/white-space等;
其他属性包括:list-style列表样式/cursor/z-index层叠顺序/zoom等;
CSS3属性:transform/transition/animation/box-shadow/border-radius
如果使用CSS3的属性,如果有必要加入浏览器前缀,则按照-webkit-/-moz-/-ms-/-o-/std的顺序进行添加,标准属性写在最后;
链接的样式请严格按照如下顺序添加:a:link->a:visited->a:hover->a:active
所列出的这些属性只是最常用到的,并不代表全部;
书写代码前,考虑并提高样式重复使用率;
充分利用html自身属性及样式继承原理减少代码量,比如:
<ulclass=”list”><li>这儿是标题列表<span>2010-09-15</span></ul>
CSS定义:
li{position:relative}lispan{position:absolute;right:0}
即可实现日期居右显示
样式表中中文字体名,请务必转码成unicode码,以避免编码错误时乱码
严格区分作为内容的图片和作为背景的图片;作为背景的图片采用Csssprite技术,放在一张大图里;Csssprite技术的优点是减少了http请求数,但使图片面向css的backround-position增加了耦合度,也增加了维护成本;如果图片有修改,不要删除已添加的图片,在空白处新增修改后的图片,减少修改风险;
使用table标签时尽量避免使用table标签,请不要用width,height,cellspacing,cellpadding等table属性直接定义表现,应尽可能的利用table自身私有属性分离结构与表现,如thead,tr,th,td,tbody,tfoot,colgroup,scopecellspaing及cellpadding的css控制方法:table{border:0;margin:0;border-collapse:collapse;}tableth,tabletd{padding:0;}
一般在公用的文件中进行初始化表格样式
杜绝使用<metahttp-equiv=”X-UA-Compatible”content=”IE=7″/>兼容ie8;
用png图片做图片时,要求图片格式为png-8格式,若png-8实在影响图片质量或其中有半透明效果,请为ie6单独定义背景:
<ulclass=”list”><li>这儿是标题列表<span>2010-09-15</span></ul>
background:none;_filter:progid:避免兼容性属性的使用,比如:text-shadow等css3的相关属性;
性能优化:
减少使用影响性能的属性,比如:position:absolute,float;
合并margin、padding、border的-left/-top/-right/-bottom的设置,尽量使用短名称;
选择器应该在满足功能的基础上尽量简短,减少选择器嵌套,查询消耗;但是一定要避免覆盖全局样式设置;
注意选择器的性能,不要使用低性能的选择器;
禁止在css中使用选择符;
除非必须,否则,一般有class或id的,不需要再写上元素对应的tag;
0后面不需要单位,比如0px可以省略成0,;
如果是16进制表示颜色,则颜色取值应该大写;
如果可以,颜色尽量用三位字符表示,例如AABBCC写成ABC;
如果没有边框时,不要写成border:0,应该写成border:none;
尽量避免使用AlphaImageLoader;
在保持代码解耦的前提下,尽量合并重复的样式;
background、font等可以缩写的属性,尽量使用缩写形式;
CSS注释;
每个CSS文件开头必须注释,如:
/
description:中文说明
author:name作者
update:name2013-04-1318:32更新
/
大区块必须注释,小区块适量注释,如:
/Header/
/Footer/
/Gallery/
代码缩进与格式:建议单行书写,可根据自身习惯,后期优化i会统一处理;
JavaScript书写规范
文件编码统一为utf-8,书写过程过,每行代码结束必须有分号;原则上所有功能均根据XXX项目需求原生开发,以避免网上down下来的代码造成的代码污染沉冗代码与现有代码冲突…;
库引入:原则上仅引入jQuery库,若需引入第三方库,须与团队其他人员讨论决定;
变量命名:驼峰式命名;原生JavaScript变量要求是纯英文字母,首字母须小写,如iTaoLun;
jQuery变量要求首字符为‘_’,其他与原生JavaScript规则相同,如:_iTaoLun;另注:要求变量集中声明,避免全局变量;
类命名:首字母大写,驼峰式命名;如:ITaoLun;
函数命名:首字母小写驼峰式命名;如:iTaoLun;
命名语义化,尽可能利用英文单词或其缩写;
尽量避免使用存在兼容性及消耗资源的方法或属性,比如:eval&innerText;
后期优化中,JavaScript非注释类中文字符须转换成unicode编码使用,以避免编码错误时乱码显示;
代码结构明了,加适量注释;提高函数重用率;
注重与html分离,减小reflow,注重性能;
图片规范
所有页面元素类图片均放入img文件夹,测试用图片放于img/demoimg文件夹;
图片格式仅限于gif、png、jpg;
前端代码开发规范 来自淘豆网m.daumloan.com转载请标明出处.
