1、前端开发规范1、 基本准则符合web标准, 语义化html, 结构表现行为分离, 兼容性优良. 页面性能方面, 代码要求简洁明了有序, 尽可能的减小服务器负载, 保证最快的解析速度.二、文件规范1. html, css, js, images文件均归档至约定的目录中;2. html文件命名: 英文命名, 后缀.html. 同时将对应界面稿放于同目录中, 若界面稿命名为中文, 请重命名与html文件同名, 以方便后端添加功能时查找对应页面;3. css文件命名: 英文命名, 后缀.css. 共用global.css, 首页index.css, 其他页面依实际模块需求命名.;4. Js文件命名:
2、英文命名, 后缀.js. 共用global.js, 其他依实际模块需求命名.3、 书写规范HTML基本架构请参照template.html,移动端参照template-mobile.html1. 文档类型声明及编码: 统一为html5声明类型; 编码统一为, 书写时利用IDE实现层次分明的缩进;2. 非特殊情况下样式文件必须外链至之间;非特殊情况下JavaScript文件必须外链至页面底部;3. 引入样式文件或JavaScript文件时, 须略去默认类型声明.CSS:JS:4. 引入JS库文件, 文件名须包含库名称及版本号及是否为压缩版, 比如jquery-1.7.1.min.js; 引入插件
3、, 文件名格式为库名称+插件名称, 比如jQuery.cookie.js;5. 所有编码均遵循xhtml标准, 标签 & 属性 & 属性命名 必须由小写字母及中、下划线数字组成, 且所有标签必须闭合; 属性值必须用双引号包括;6. 充分利用无兼容性问题的html自身标签, 比如span, em, strong, optgroup, label,等等; 需要为html元素添加自定义属性的时候, 首先要考虑下有没有默认的已有的合适标签去设置, 如果没有, 可以使用须以”data-”为前缀来添加自定义属性,避免使用”data:”等其他命名方式;7. 语义化html, 如 标题根据重要性用h(同一页面
4、只能有一个h1), 段落标记用p, 列表用ul, 内联元素中不可嵌套块级元素;8. 尽可能减少div嵌套9. 书写链接地址时, 必须避免重定向,例如:href=”http:/ 即须在URL地址后面加上“/”;10. 在页面中尽量避免使用style属性,即style=”;11. 能以背景形式呈现的图片, 尽量写入css样式中;12. 重要图片必须加上alt属性; 给重要的元素和截断的元素加上title;13. 给区块代码及重要功能(比如循环)加上注释, 方便后台添加功能;14. 特殊符号使用: 尽可能使用代码替代: 比如 () & 空格( ) & () 等等;15. 书写页面过程中, 请考虑向后
5、扩展性;CSS重置样式引用reset.css1. 编码统一为utf-8;2. class与id的使用: id是唯一的, class是可以重复的, 所以id尽量使用在大的模块上, class可用在重复使用率高及子级中; 常用命名:容 器:container/box头 部:header主 导 航:nav子 导 航:nav-sub顶 导 航:nav-top网站标志:logo大 广 告:banner页面中部:main底 部:footer菜 单:menu菜单内容:menu-content子 菜 单:menu-sub搜 索:search搜索关键字:keyword搜索范围:range标签文字:tag-tit
6、le标签内容:tag-content当前标签:tag-active标 题:title内 容:content列 表:list当前位置:nav-dir侧 边 栏:side图 标:icon注 释:note登 录:login注 册:register3. 为JavaScript预留钩子的命名, 请以 js_ 起始, 比如: js_hide, js_show;4.class与id命名:大的框架命名比如header/footer/wrapper/left/right.其他样式名称由 小写英文 & 数字 & - 来组合命名, 如top-comment, fontred, width200; 避免使用中文拼音,
7、 尽量使用简易的单词组合; 总之, 命名要语义化, 简明化.5. css属性书写顺序, 建议遵循: 布局定位属性自身属性文本属性其他属性. 此条可根据自身习惯书写, 但尽量保证同类属性写在一起. 属性列举: 布局定位属性主要包括: display & list-style & position(相应的 top,right,bottom,left) float & clear visibility overflow; 自身属性主要包括: width & height & margin & padding & border & background; 文本属性主要包括:color & font &
8、 text-decoration & text-align & vertical-align & white- space & 其他 & content; 这些属性只是最常用到的, 并不代表全部;6. 充分利用html自身属性及样式继承原理减少代码量7. 背景图片请尽可能使用sprite技术, 减小http请求, 考虑到多人协作开发, sprite按模块制作;8. 使用table标签时(尽量避免使用table标签), 请不要用width/ height/cellspacing/cellpadding等table属性直接定义表现, 应尽可能的利用table自身私有属性分离结构与表现 , 如the
9、ad,tr,th,td,tbody,tfoot,colgroup,scope; (cellspaing及cellpadding的css控制方法:tableborder:0;margin:0;border-collapse:collapse; table th, table tdpadding:0;)9. 用png图片做图片时, 要求图片格式为png-8格式,若png-8实在影响图片质量或其中有半透明效果, 请为ie6单独定义背景:_background:none;_filter:progid:DXImageTransform.Microsoft.AlphaImageLoader (sizing
10、Method=crop, src=img/bg.png);10. 减少使用影响性能的属性, 比如position:absolute | float ;11. 代码缩进与格式: 建议单行书写, 可根据自身习惯;JavaScript1. 文件编码统一为utf-8, 书写过程过, 每行代码结束必须有分号;2. 变量命名: 驼峰式命名. 原生JavaScript变量要求是纯英文字母, 首字母须小写, 如flower;每个局部变量都需要有一个类型前缀,按照类型可以分为:s:表示字符串。例如:sName,sHtml;n:表示数字。例如:nPage,nTotal;b:表示逻辑。例如:bChecked,bHa
11、sLogin;a:表示数组。例如:aList,aGroup;r:表示正则表达式。例如:rDomain,rEmail;f:表示函数。例如:fGetHtml,fInit;o:表示以上未涉及到的其他对象,例如:oButton,oDate;作用域不大临时变量可以简写,比如:str,num,bol,obj,fun,arr,循环变量可以简写,比如:i,j,k等,另要求变量集中声明, 避免全局变量.3. 类名首个字母必需大写,例如Image,Support等。属性名需要是有意义的名词,首字母小写,例如oImage.width。方法名需要是有意义的动词+名词,首字母小写,例如Support.getWidth.
12、如果不希望被其他方法调用,需要在属性或者方法名前面加“_”,例如oImage._language.如果不希望被子类调用,需要在属性或者方法名前加“_”,例如oImage._fire()4.排版缩进 采用统一的缩进方式排版代码。缩进为2个ASCII空格If(condition1 | condition2) action1; else if (condition3 & condition4) action2; else if (condition5 & condition6 & condition7 & condition8) action2; else default action;5.关键词、
13、条件括弧后面使用空格;运算操作符号两侧使用空格;语句分割符,后面使用空格var name空格=空格value;if空格(a,空格b) 6. 左大括号可以居行尾,也可写在下行首(独自一行);右大括号单独占一行,居行首if (a & b) -if (a & b) 7. 句末必须用分号结尾var fn = function () ;/这里没有分号的话,脚本解析器会报错!(function () alert(1);)();8.单行过长应在适当位置予以换行,增强可读性if 语句括号中的条件若过多过长,应予以折行;折行后,|、& 等符号应与 “(” 后的第一个字母纵向对齐9. if、while、for、d
14、o语句的执行体总是用和括起来,即使在其结构体内只有一条语句10. 语法意义相互独立的代码将用空行分隔11. 尽量避免使用存在兼容性及消耗资源的方法或属性, 比如eval_r() & innerText;12. 代码结构明了, 加适量注释. 提高函数重用率;13. 注重与html分离, 减小reflow, 注重性能.图片1. 所有页面元素类图片均放入imges文件夹, 测试用图片放于imges/demo文件夹;2. 图片格式仅限于gif | png | jpg;3. 命名全部用小写英文字母 | 数字 | - | _ 的组合,其中不得包含汉字 | 空格 | 特殊字符;尽量用易懂的词汇, 便于团队其
15、他成员理解; 另, 命名分头尾两部分, 用下划线隔开, 比如ad-left01.gif | btn_submit.gif;4. 在保证视觉效果的情况下选择最小的图片格式与图片质量, 以减少加载时间;5. 尽量避免使用半透明的png图片6. 运用css sprite技术集中小的背景图或图标, 减小页面http请求注释1. html注释: 注释格式, 只能在注释的始末位置,不可置入注释文字区域;2. css注释: 注释格式 ;3. JavaScript注释, 单行注释使用/这儿是单行注释 ,多行注释使用 ;开发及测试工具约定建议使用WebStorm|Aptana | Dw | Vim , 亦可根据自己喜好选择, 但须遵循如下原则:1. 不可利用IDE的视图模式画代码;2. 不可利用IDE生成相关功能代码, 比如Dw内置的一些功能js;3. 编码必须格式化, 比如缩进;测试工具: 前期开发仅测试FireFox & IE7 & IE8 & IE9 & Chrome & Safari;其他规范1. 开发过程中严格按分工完成页面, 以提高css复用率, 避免重复开发;2. 减小沉冗代码, 书写所有人都可以看的懂的代码. 简洁易懂是一种美德. 为用户着想, 为服务器着想.