前端开发规范标准

时间 2019-11-20

标签前端开发规范标准繁體版

原文原文链接

Web前端做为开发团队中不可或缺的一部分，须要按照相关规定进行合理编写（一部分不良习惯可能给本身和他人形成没必要要的麻烦）。不一样公司不一样团队具备不一样的规范和文档。下面是根据不一样企业和团队的要求进行全面详细的整理结果。备注：实际开发请以本公司的规范为标准。css

A.基本原则html

符合web标准（UTF-8，HTML5），语义化html（HTML5新增要求，减小div和span等无特定语义的标签使用），结构表现行为分离（HTML-CSS-JS代码分离，不一样行为代码高内聚低耦合），兼容性优良（早期版本浏览器兼容，移动端和PC端设备兼容）.页面性能方面（减小请求次数，例如使用精灵图和sass语法），代码要求简洁明了有序，尽量的减少服务器负载，保证最快的解析速度（减少repaint和reflow）.前端

B.文件命名规范html5

一、html，css，js，lib，images文件均存放至项目的目录中。若是使用相关前端框架，根据框架的文件格式进行合理布局。jquery

二、全部文件夹及文件使用英文命名（避免使用中文路径）。css3

三、html文件：入口文件使用index.html。若是有对应的设计组设计原稿，须要将对应的设计稿和html文件命名一致并合理存放。web

四、css文件命名：后缀.css。通用initial.css，初始化base.css，首页index.css，其余页面按照对应的html命名。bootstrap

五、Js文件命名：英文命名，后缀.js.通用common.js，初始化base.js。其余页面按照对应的html命名。浏览器

C.HTML规范sass

一、文档类型声明及编码：统一为html5声明类型。书写时利用IDE实现井井有条的缩进（默认缩进4空格）。

二、非特殊状况下CSS文件放在body部分<meta>标签后。非特殊状况下大部分JS文件放在<body>标签尾部（若是须要界面未加载前执行的代码能够放在head标签后）避免行内JS和CSS代码。

三、全部编码须要遵循html（XML）标准，标签&属性&属性命名必须由小写字母及下划线数字组成，且全部标签必须闭合，包括br()，hr()等。属性值用双引号。

四、引入JS库文件，文件名须包含库名称及版本号及是否为压缩版，好比jquery-1.4.1.min.js。引入插件，文件名格式为库名称+插件名称，好比jQuery.bootstrap.js。

五、书写页面过程当中，请考虑向后扩展性。class&id参见css书写规范.

六、须要为html元素添加自定义属性的时候，首先要考虑下有没有默认的已有的合适标签去设置，若是没有，可使用须以"data-"为前缀来添加自定义属性，避免使用"data："等其余命名方式。

七、语义化html，如标题根据重要性用h*(同一页面只能有一个h1)，段落标记用p，列表用ul，内联元素中不可嵌套块级元素。

八、尽量减小div多层级嵌套。

九、书写连接地址时，必须避免重定向，例如：href="http：//myVue.com/"，即须在URL地址后面加上“/”；

十、在页面中尽可能避免使用style属性，即style="…"。

十一、必须为含有描述性表单元素(input，textarea)添加label，如姓名：须写成：姓名：

十二、能以背景形式呈现的图片，尽可能写入css样式中。

1三、重要图片必须加上alt属性。给重要的元素和截断的元素加上title。

1四、给区块代码及重要功能(好比循环)加上注释，方便后台添加功能。

1五、特殊符号使用：尽量使用代码替代：好比<(<)&>(>)&空格()&»(»)等等。

D.CSS规范

一、编码规范为utf-8。

二、协做开发及分工：i会根据各个模块，同时根据页面类似程序，事先写**体框架文件，分配给前端人员实现内部结构&表现&行为。共用css文件base.css由i书写，协做开发过程当中，每一个页面请务必都要引入，此文件包含reset及头部底部样式，此文件不可随意修改。

三、class与id的使用：id是惟一的并是父级的，class是能够重复的并是子级的，因此id仅使用在大的模块上，class可用在重复使用率高及子级中。id原则上都是由我分发框架文件时命名的，为JS预留钩子的除外。

四、为JS预留钩子的命名，请以js_起始，好比：js_hide，js_show。

五、class与id命名：大的框架命名好比header/footer/wrapper/left/right之类的在2中由i统一命名.其余样式名称由小写英文&数字&来组合命名，如i_comment，fontred，width200。避免使用中文拼音，尽可能使用简易的单词组合。总之，命名要语义化，简明化

六、规避class与id命名(此条重要，如有不明白请及时与i沟通)：a）经过从属写法规避，示例见d。b）取父级元素id/class命名部分命名，示例见d。c）重复使用率高的命名，请以本身代号加下划线起始，好比i_clear。d）a，b两条，适用于在2中已建好框架的页面，如，要在2中已建好框架的页面代码中加入新的div元素，按a命名法则：...，样式写法：#mainnav.firstnav{.......}按b命名法则：...，样式写法：.main_firstnav{.......}

七、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自身属性及样式继承原理减小代码量

十、样式表中中文字体名，请务必转码成unicode码，以免编码错误时乱码。

十一、背景图片请尽量使用精灵图技术，减少http请求，考虑到多人协做开发，精灵图按模块制做。

十二、使用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。}，base.css文件中我会初始化表格样式)

1三、杜绝使用兼容ie8。

1四、用png图片作图片时，要求图片格式为png-8格式，若png-8实在影响图片质量或其中有半透明效果，请为ie6单独定义背景：_background：none。_filter：progid：DXImageTransform.Microsoft.AlphaImageLoader(sizingMethod=crop，src=’img/bg.png’)。

1五、避免兼容性属性的使用，好比text-shadow||css3的相关属性。

1六、减小使用影响性能的属性，好比position：absolute||float。

1七、必须为大区块样式添加注释，小区块适量注释。

1八、代码缩进与格式：建议单行书写，可根据自身习惯，后期优化会统一处理。

E. JS书写规范

一、文件编码统一为utf-8，书写过程过，每行代码结束必须有分号。原则上全部功能均根据XXX项目需求原生开发，以免网上down下来的代码形成的代码污染(沉冗代码||与现有代码冲突||...)。

二、库引入：原则上仅引入jQuery库，若需引入第三方库，须与团队其余人员讨论决定。

三、变量命名：驼峰式命名.原生JS变量要求是纯英文字母，首字母须小写，如myVue。jQuery变量要求首字符为'_'，其余与原生JS规则相同，如：_myVue。另，要求变量集中声明，避免全局变量.

四、类命名：首字母大写，驼峰式命名.如MyVue。

五、函数命名：首字母小写驼峰式命名.如myVue()。

六、命名语义化，尽量利用英文单词或其缩写。

七、尽可能避免使用存在兼容性及消耗资源的方法或属性，好比eval_r()&innerText。

八、后期优化中，JS非注释类中文字符须转换成unicode编码使用，以免编码错误时乱码显示。

九、代码结构明了，加适量注释.提升函数重用率。

十、注重与html分离，减少reflow，注重浏览器性能.

F.图片规范

一、全部页面元素类图片均放入img文件夹，测试用图片放于demo文件夹。

二、图片格式gif/png/jpg。提倡使用webp文件格式，使用软件进行图片压缩。

三、命名所有用小写英文字母||数字||_的组合，其中不得包含汉字||空格||特殊字符；尽可能用易懂的词汇，便于团队其余成员理解。另，命名分头尾两部分，用下划线隔开，好比ad_left01.gif||btn_submit.gif。

四、在保证视觉效果的状况下选择最小的图片格式与图片质量，以减小加载时间。五、尽可能避免使用半透明的png图片(若使用，请参考css规范相关说明)。

六、运用css精灵图技术集中小的背景图或图标，减少页面http请求，但注意，请务必在对应的精灵图psd源图中划参考线，并保存至img目录下

G.测试规范

开发及测试工具约定建议使用Aptana-Sublime-Vim-WebStrom，亦可根据本身喜爱选择，但须遵循以下原则：

一、不可利用IDE的视图模式'画'代码。

二、不可利用IDE生成相关功能代码。

三、编码必须格式化，好比缩进。测试工具：前期开发仅测试FireFox&IE6&IE7&IE8，后期优化时加入Opera&Chrome&Safari。建议测试顺序：FireFox-->IE-->Opera-->Chrome-->Safari。--------------------- 做者：Michael1822852997 来源：CSDN 原文：https://blog.csdn.net/weixin_41697143/article/details/81049778