WEB前端开发规范文档

范文范例指导参考学习资料整理分享WEB前端开发规范文档目录WEB前端开发规范文档.............................................................................................1规范目的................................................................................................................2基本准则................................................................................................................3文件规范................................................................................................................3html书写规范........................................................................................................3html其他规范........................................................................................................5css书写规范..........................................................................................................7JavaScript书写规范...............................................................................................8jQuery部分............................................................................................................9开发及测试工具约定............................................................................................10其他规范..............................................................................................................11范文范例指导参考学习资料整理分享规范目的为提高团队协作效率,便于后台人员添加功能及前端后期优化维护,输出高质量的文档,特制订此文档:本规范文档一经确认,前端开发人员必须按本文档规范进行前台页面开发:本文档如有不对或者不合适的地方请及时提出,经讨论决定后方可更改:范文范例指导参考学习资料整理分享基本准则1：符合web标准,语义化html,遵循内容（HTML）、显示（CSS）、行为（JavaScript）分离的代码组织模式。2：代码格式化，保持干净整洁。3：换行必须缩进一个tab。4：编写所有前台页面时，请使用已有模板进行复制，在模板的基础上进行开发。5：每一个页面都必须有一个独立的css，js文件。6：如果不是用HTML5编写的网站，请用IE7，IE8，IE9，火狐，谷歌，webkit，safari内核进行测试兼容性。7：如果是HTML5编写的网站，请用IE9，火狐，谷歌，webkit，safari内核进行测试兼容性。文件规范1:html,css,js,images文件均归档至系统开发规范约定的目录中;2:html文件命名:英文命名,后缀:htm:同时将对应界面稿放于同目录中,若界面稿命名为中文,请重命名与html文件同名,以方便后端添加功能时查找对应页面;3:css文件命名:英文命名,后缀:css:共用base:css,首页index:css,其他页面依实际模块需求命名:;4:Js文件命名:英文命名,后缀:js:共用common:js,其他依实际模块需求命名:html书写规范1：所有元素都必须小写，属性也是，如：inputtype=”text”id=”idName”/正确范文范例指导参考学习资料整理分享INPUTTYPE=”text”ID=”idName”/错误2：元素必须成对出现，如span必须写成span/span特殊元素除外，如：br/hr/img/input/3：标签中不允许出现样式，必须用class来声明样式，如：inputtype=”text”id=”idName”style=”text-align:right;”/错误inputtype=”text”id=”idName”class=”class-name”/正确4：元素id命名必须是驼峰式命名如：inputtype=”text”id=”idName”/正确inputtype=”text”id=”idname”/错误inputtype=”text”id=”id-name”/错误5：元素class命名规范是：元素简写+”-”+功能名，如：buttoncalss=”btn-save”/button正确buttoncalss=”btnSave”/button错误buttoncalss=”save”/button错误6：元素name命名必须遵循驼峰式命名法。inputtype=”text”name=”idName”/正确inputtype=”text”name=”idname”/错误inputtype=”text”name=”id-name”/错误7：元素属性必须有值：inputtype=”checkbox”checked=”checked”/正确8：元素属性必须用双引号，不允许使用单引号。范文范例指导参考学习资料整理分享inputtype=”checkbox”checked=”checked”/正确inputtype=’checkbox’checked=’checked’/错误9：如果元素需要自定义属性，请用data-xxx方式命名。10：严禁使用已在XHTML1:0中已移除的标签，如：s，i，b，font等html其他规范1:文档类型声明及编码:统一为html5声明类型!DOCTYPEhtml;编码统一为metacharset=UTF-8/,书写时利用IDE实现层次分明的缩进;2:非特殊情况下样式文件必须外链至head:::/head之间;非特殊情况下JavaScript文件必须外链至页面底部;3:引入样式文件或JavaScript文件时,须略去默认类型声明,写法如下:ExampleSourceCode[:com]linkrel=stylesheethref=:::/style:::/stylescriptsrc=:::/script4:引入JS库文件,文件名须包含库名称及版本号及是否为压缩版,比如jquery-1:4:1:min:js;引入插件,文件名格式为库名称+插件名称,比如jQuery:cookie:js;5:所有编码均遵循xhtml标准,标签&属性&属性命名必须由小写字母及下划线数字组成,且所有标签必须闭合,包括br(br/),hr(hr/)等;属性值必须用双引号包括;6:充分利用无兼容性问题的html自身标签,比如span,em,strong,optgroup,label,等等;需要为html范文范例指导参考学习资料整理分享元素添加自定义属性的时候,首先要考虑下有没有默认的已有的合适标签去设置,如果没有,可以使用须以data-为前缀来添加自定义属性，避免使用data:等其他命名方式;7:语义化html,如标题根据重要性用h*(同一页面只能有一个h1),段落标记用p,列表用ul,内联元素中不可嵌套块级元素;8:尽可能减少div嵌套,如divclass=boxdivclass=welcome欢迎访问XXX,您的用户名是divclass=name用户名/div/div/div完全可以用以下代码替代:divclass=boxp欢迎访问XXX,您的用户名是span用户名/span/p/div;9:书写链接地址时,必须避免重定向，例如：href=即须在URL地址后面加上“/”；10:在页面中尽量避免使用style属性,即style=…;11:必须为含有描述性表单元素(input,textarea)添加label,如ExampleSourceCode[:com]p姓名:inputtype=textid=namename=name//p须写成:plabelfor=name姓名:/labelinputtype=textid=name//p12:能以背景形式呈现的图片,尽量写入css样式中;13:重要图片必须加上alt属性;给重要的元素和截断的元素加上title;14:给区块代码及重要功能(比如循环)加上注释,方便后台添加功能;15:特殊符号使用:尽可能使用代码替代:比如()&()&空格()&»(»)等等;16:书写页面过程中,请考虑向后扩展性;范文范例指导参考学习资料整理分享css书写规范1：元素尽量使用class选择器匹配，对于特殊功能可以考虑使用ID选择器。2：明确各选择器的优先级，作用范围。3：CSS写完之后必须使用“;”号结尾，虽然浏览器支持不用分号结尾，但是不建议这么做。4：除非编写HTML5页面，否则不允许使用CSS3伪类，如：:nth-child(1)等伪类，禁止使用。5：编写CSS样式时，不允许换行，样式必须一行写完，自动换行除外。6：对于子元素样式采用链选择器进行选择，如：:btn-savediv7：元素选择器只能在定义全局CSS和子元素匹配时使用（尽量少用），其他地方禁止使用。8：请记住IE浏览器的hack方式，如下：IE6=_width:100px;IE7=*width:100px;IE8=width:100px\9;IE8/9=width:100px\0;IE9=width:100px\9\0;9：:编码统一为utf-8;10：css属性书写顺序,建议遵循:布局定位属性--自身属性--文本属性--其他属性:此条可根据自身习惯书写,但尽量保证同类属性写在一起:11：书写代码前,考虑并提高样式重复使用率;12：充分利用html自身属性及样式继承原理减少代码量,比如:ExampleSourceCode[:com]范文范例指导参考学习资料整理分享ulclass=listli这儿是标题列表span2010-09-15/span/ul定义ul:listli{position:relative}ul:listlispan{position:absolute;right:0}即可实现日期居右显示13：样式表中中文字体名,请务必转码成unicode码,以避免编码错误时乱码;14：使用table标签时(尽量避免使用table标签),请不要用width/height/cellspacing/cellpadding等table属性直接定义表现,应尽可能的利用table自身私有属性分离结构与表现,如Example