web前端约束文档
几年的前端开发，多少也积累一些常用的经验，既然有前端团队协作，那么统一的开发约束文档还是有必要整理一下的。减少不必要的沟通成本，将多股力量拧成一股，才能发挥最大的效果。
这个文档不能说成是规范文档，因为规范这玩意很难界定，我说它规范，但是你也许不这样认为，所以叫做约束会好点。适当的约束还是有必要的，就不举风筝与线的例子了。。
WEB前端开发约束文档
约束目的
为提高团队协作效率, 便于后期优化维护, 输出高质量的文档, 特制订此文档.
基本准则
符合web标准, 语义化html, 结构表现行为分离, 兼容性优良. 页面性能方面, 代码要求简洁明了有序, 尽可能的减小服务器负载, 保证最快的解析速度.
文件规范
1. htm，css，js文件命名: 尽量保证英文缩写的命名, 不要出现拼音的命名，文件名统一小写，多个单词可以用英文下划线“_”连接。
html书写规范
1. 文档类型声明及编码: 统一为html5声明类型<!DOCTYPE html>; 编码统一为<meta charset="utf-8" />, 书写时统一使用tab键实现层次分明的缩进;
2. 非特殊情况下样式文件必须外链至<head>...</head>之间
3. 引入样式文件或JavaScript文件时, 须略去默认类型声明, 写法如下:
<link rel="stylesheet" href="..." />
<style>...</style>
<script src="..."></script>
4. 不可随意引入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. 尽可能减少html标签嵌套；
9. 书写链接地址时, 必须避免重定向，例如：href="http://xxx.com/", 即须在URL地址后面加上“/”；
10. 严禁在页面中使用style属性,即style="…"，javascript代码生成的除外;
11.必须为含有描述性表单元素(input, textarea)添加label；
12. 能以背景形式呈现的图片, 尽量写入css样式中;
13. 重要图片必须加上alt属性; 给重要的元素和截断的元素加上title;
14. 给区块代码及重要功能(比如循环)加上注释, 方便日后维护;
15. 特殊符号使用: 尽可能使用代码替代: 比如 <(<) & >(>) & 空格( ) & »(») 等等;
16. 书写页面过程中, 请考虑向后扩展性;
css书写规范
1. 编码统一为utf-8;
2. 公用css文件命名为base.css,协作开发过程中,每个页面请务必都要引入,此文件包含reset及头部底部样式, 此文件不可随意修改;
3. class与id的使用: id是唯一的并是父级的, class是可以重复的并是子级的, 所以id仅使用在大的模块上, class可用在重复使用率高及子级中; 在html中添加样式尽量使用class,ID留给JavaScript预留钩子;
4. class与id命名: 大的框架命名比如header/footer/wrapper/left/right之类的在2中统一命名.其他样式名称由小写英文开头后面可以加英文下划线来连接单词，避免使用中文拼音, 尽量使用简易的单词组合; 总之, 命名要语义化, 简明化.
6. 规避class与id命名：
a, 通过从属写法规避, 示例见d;
b, 取父级元素id/class命名部分命名;
c, 尽量重复使用一个命名，前面通过不同的父级class或者id来限制；
7. css 属性书写顺序, 建议遵循 布局定位属性-->自身属性-->文本属性-->其他属性. 此条可根据自身习惯书写, 但尽量保证同类属性写在一起. 属性列举: 布局定位属性主要包括: margin ＆ padding ＆ float（包括clear） ＆ position（相应 的 top,right,bottom,left） ＆ display ＆ visibility ＆ overflow等； 自身属性主要包 括: width & height & background & border; 文本属性主要包括： font ＆ color ＆ text-align ＆ text-decoration ＆ text-indent等；其他属性包括: list-style(列 表样式) ＆ vertical-vlign ＆ cursor ＆ z-index(层叠顺序) ＆ zoom等. 我所列出的这些属性只是最常用到 的, 并不代表全部;
8. 书写代码前, 考虑并提高样式重复使用率;
9. 充分利用html自身属性及样式继承原理减少代码量, 比如:
<ul class="list"><li>这儿是标题列表<span>2010-09-15</span></ul>
定义
ul.list li{position:relative} ul.list li span{position:absolute; right:0}
即可实现日期居右显示
10. 样式表中中文字体名, 请务必转码成unicode码, 以避免编码错误时乱码;
11. 背景图片请尽可能使用sprite技术, 减小http请求, 考虑到多人协作开发, sprite按模块制作;
12. 使用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;} table th, table td{padding:0;} , base.css文件中会有初始化表格样式)
13. 用png图片做图片时, 要求图片格式为png-8格式,若png-8实在影响图片质量或其中有半透明效果, 请为ie6单独定义背景:
14. 避免兼容性属性的使用, 比如text-shadow || css3的相关属性;
15. 必须为大区块样式添加注释, 小区块适量注释;
JavaScript书写规范
1. 文件编码统一为utf-8, 书写过程过,每行代码结束必须有分号;原则上所有功能均根据项目需求原生开发,以避免网上down下来的代码造成的代码污染(沉冗代码 || 与现有代码冲突 || ...);
2. 库引入: 原则上仅引入jQuery库, 若需引入第三方库, 须与团队其他人员讨论决定;
3. 变量命名: 驼峰式命名. 原生JavaScript变量要求是纯英文字母, 首字母须小写, 如iTaoLun;另, 要求变量集中声明, 避免全局变量.
4. 类命名: 首字母大写, 驼峰式命名;
5. 函数命名: 首字母小写驼峰式命名;
6. 命名语义化, 尽可能利用英文单词或其缩写;
7. 尽量避免使用存在兼容性及消耗资源的方法或属性, 比如eval & with;
8. 后期优化中, JavaScript非注释类中文字符须转换成unicode编码使用, 以避免编码错误时乱码显示;
9. 代码结构明了, 加适量注释. 提高函数重用率;
10. 注重与html分离, 减小reflow, 注重性能.
图片规范
1. 所有页面元素类图片均放入img统一的文件夹;
2. 图片格式仅限于gif || png || jpg;
3. 命名全部用小写英文字母 || 数字 || _ 的组合，其中不得包含汉字 || 空格 || 特殊字符；尽量用易懂的词汇, 便于团队其他成员理解; 另, 命名分头尾两部分, 用下划线隔开, 比如ad_left01.gif || btn_submit.gif;
4. 在保证视觉效果的情况下选择最小的图片格式与图片质量, 以减少加载时间;
5. 尽量避免使用半透明的png图片(若使用, 请参考css规范相关说明);
6. 运用css sprite技术集中小的背景图或图标, 减小页面http请求, 但注意, 请务必在对应的sprite psd源图中划参考线, 并保存至img目录下.
注释规范
1. html注释: 注释格式 <!--这儿是注释-->, '--'只能在注释的始末位置,不可置入注释文字区域;
2. css注释: 注释格式 /*这儿是注释*/;
3. JavaScript注释, 单行注释使用'//这儿是单行注释' ,多行注释使用 /* 这儿有多行注释 */;
开发及测试工具约定
可根据自己喜好选择, 但须遵循如下原则:
1. 不可利用IDE的视图模式'画'代码;
2. 不可利用IDE生成相关功能代码, 比如Dw内置的一些功能js;
3. 编码必须格式化, 比如缩进;
测试工具: 前期开发仅测试FireFox & IE6 & IE7 & IE8 , 后期优化时加入Opera & Chrome;
建议测试顺序: FireFox-->IE7-->IE8-->IE6-->Opera-->Chrome, 建议安装firebug及IE Tab Plus插件.
其他规范
1. 开发过程中严格按分工完成页面, 以提高css复用率, 避免重复开发;
2. 减小沉冗代码,书写所有人都可以看的懂的代码.简洁易懂是一种美德.为自己着想, 也为他人着想.
