一,基本原则
符合web标准(UTF-8,HTML5),语义化html(HTML5新增要求,减少div和span等无特定语义的标签使用),结构表现行为分离(HTML-CSS-JS代码分离,不同行为代码高内聚低耦合),兼容性优良(早期版本浏览器兼容,移动端和PC端设备兼容).页面性能方面(减少请求次数,例如使用精灵图和sass语法),代码要求简洁明了有序,尽可能的减小服务器负载,保证最快的解析速度(减小repaint和reflow)。
二,文件命名规范
- html,css,js,lib,images文件均存放至项目的目录中。如果使用相关前端框架,根据框架的文件格式进行合理布局。
- 所有文件夹及文件使用英文命名(避免使用中文路径)。
- html文件:入口文件使用index.html。如果有对应的设计组设计原稿,需要将对应的设计稿和html文件命名一致并合理存放。
- css文件命名:后缀.css。通用initial.css,初始化base.css,首页index.css,其他页面按照对应的html命名。
- Js文件命名:英文命名,后缀.js.通用common.js,初始化base.js。 其他页面按照对应的html命名。
三,HTML规范
1、文档类型声明及编码:统一为html5声明类型。书写时利用IDE实现层次分明的缩进(默认缩进4空格)。
2、非特殊情况下CSS文件放在body部分标签后。非特殊情况下大部分JS文件放在标签尾部(如果需要界面未加载前执行的代码可以放在head标签后)避免行内JS和CSS代码。
3、所有编码需要遵循html(XML)标准,标签&属性&属性命名必须由小写字母及下划线数字组成,且所有标签必须闭合,包括br(),hr()等。属性值用双引号。
4、引入JS库文件,文件名须包含库名称及版本号及是否为压缩版,比如jquery-1.4.1.min.js。引入插件,文件名格式为库名称+插件名称,比如jQuery.bootstrap.js。
5、书写页面过程中,请考虑向后扩展性。class&id参见css书写规范.
6、需要为html元素添加自定义属性的时候,首先要考虑下有没有默认的已有的合适标签去设置,如果没有,可以使用须以"data-"为前缀来添加自定义属性,避免使用"data:"等其他命名方式。
7、语义化html,如标题根据重要性用h*(同一页面只能有一个h1),段落标记用p,列表用ul,内联元素中不可嵌套块级元素。
8、尽可能减少div多层级嵌套。
9、书写链接地址时,必须避免重定向,例如:href="http://myVue.com/",即须在URL地址后面加上“/”;
10、在页面中尽量避免使用style属性,即style="…"。
11、必须为含有描述性表单元素(input,textarea)添加label,如姓名:须写成:姓名:
12、能以背景形式呈现的图片,尽量写入css样式中。
13、重要图片必须加上alt属性。给重要的元素和截断的元素加上title。
14、给区块代码及重要功能(比如循环)加上注释,方便后台添加功能。
15、特殊符号使用:尽可能使用代码替代:比如<(<)&>(>)&空格()&»(»)等等。
四,CSS规范
1、编码规范为utf-8。
2、协作开发及分工:i会根据各个模块,同时根据页面相似程序,事先写XX体框架文件,分配给前端人员实现内部结构&表现&行为。共用css文件base.css由i书写,协作开发过程中,每个页面请务必都要引入,此文件包含reset及头部底部样式,此文件不可随意修改。
3、class与id的使用:id是唯一的并是父级的,class是可以重复的并是子级的,所以id仅使用在大的模块上,class可用在重复使用率高及子级中。id原则上都是由我分发框架文件时命名的,为JS预留钩子的除外。
4、为JS预留钩子的命名,请以js_起始,比如:js_hide,js_show。
5、class与id命名:大的框架命名比如header/footer/wrapper/left/right之类的在2中由i统一命名.其他样式名称由小写英文&数字&来组合命名,如i_comment,fontred,width200。避免使用中文拼音,尽量使用简易的单词组合。总之,命名要语义化,简明化
6、规避class与id命名(此条重要,若有不明白请及时与i沟通):a)通过从属写法规避,示例见d。b)取父级元素id/class命名部分命名,示例见d。c)重复使用率高的命名,请以自己代号加下划线起始,比如i_clear。d)a,b两条,适用于在2中已建好框架的页面,如,要在2中已建好框架的页面代码中加入新的div元素,按a命名法则:...,样式写法:#mainnav.firstnav{.......}按b命名法则:...,样式写法:.main_firstnav{.......}
7、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。
8、书写代码前,提高样式重复使用率。
五,JS书写规范
1、文件编码统一为utf-8,书写过程过,每行代码结束必须有分号。原则上所有功能均根据XXX项目需求原生开发,以避免网上down下来的代码造成的代码污染(沉冗代码||与现有代码冲突||...)。
2、库引入:原则上仅引入jQuery库,若需引入第三方库,须与团队其他人员讨论决定。
3、变量命名:驼峰式命名.原生JS变量要求是纯英文字母,首字母须小写,如myVue。jQuery变量要求首字符为'_',其他与原生JS规则相同,如:_myVue。另,要求变量集中声明,避免全局变量.
4、类命名:首字母大写,驼峰式命名.如MyVue。
5、函数命名:首字母小写驼峰式命名.如myVue()。
6、命名语义化,尽可能利用英文单词或其缩写。
7、尽量避免使用存在兼容性及消耗资源的方法或属性,比如eval_r()&innerText。
8、后期优化中,JS非注释类中文字符须转换成unicode编码使用,以避免编码错误时乱码显示。
9、代码结构明了,加适量注释.提高函数重用率。
10、注重与html分离,减小reflow,注重浏览器性能。
六,个人总结
虽然Web开发并没有必须要求的开发与编写方式,但需注意,按照被大众广泛认可的书写范式去进行Web开发,才能真正使得开发的网页得到可读、可共享。
要在后续前端学习中多多重视Web开发标准,按照范式要求编写代码。