规范目的
为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的程序, 特制订此文档. 本文档如有不对或者不合适的地方请及时提出.
基本准则
符合web标准, 语义化html, 结构表现行为分离, 兼容性优良. 页面性能方面, 代码要求简洁明了有序, 尽可能的减小服务器负载, 保证最快的解析速度.
文件规范
- html, css, js, images文件均归档至<系统开发规范>约定的目录中;
- html文件命名: 英文命名, 后缀.htm. 同时将对应界面稿放于同目录中, 若界面稿命名为中文, 请重命名与html文件同名, 以方便后端添加功能时查找对应页面;
- css文件命名: 英文命名, 后缀.css. 共用base.css, 首页index.css, 其他页面依实际模块需求命名.;
- Js文件命名: 英文命名, 后缀.js. 共用common.js, 其他依实际模块需求命名.
html书写规范
- 文档类型声明及编码: 统一为html5声明类型<!DOCTYPE html>; 编码统一为<meta charset=”utf-8″ />, 书写时利用IDE实现层次分明的缩进;
- 非特殊情况下样式文件必须外链至<head>…</head>之间;非特殊情况下JavaScript文件必须外链至页面底部;
- 引入JS库文件, 文件名须包含库名称及版本号及是否为压缩版, 比如jquery-1.4.1.min.js; 引入插件, 文件名格式为库名称+插件名称, 比如jQuery.cookie.js;
- 所有编码均遵循xhtml标准, 标签 & 属性 & 属性命名 必须由小写字母及下划线数字组成, 且所有标签必须闭合, 包括br (<br />), hr(<hr />)等; 属性值必须用双引号包括;
- 充分利用无兼容性问题的html自身标签, 比如span, em, strong, optgroup, label,等等; 需要为html 元素添加自 定义属性的时候, 首先要考虑下有没有默认的已有的合适标签去设置, 如果没有, 可以使用须以”data-”为前缀来添加自定义属性，避免使 用”data:”等其他命名方式;
- 语义化html, 如 标题根据重要性用h*(同一页面只能有一个h1), 段落标记用p, 列表用ul, 内联元素中不可嵌套块级元素;
- 尽可能减少div嵌套
- 书写链接地址时, 必须避免重定向，例如：href=”http://itaolun.com/”, 即须在URL地址后面加上“/”；
- 在页面中尽量避免使用style属性,即style=”…”;
- 必须为含有描述性表单元素(input, textarea)添加label, 如<p>姓 名: <input type=”text” id=”name” name=”name” /></p>须写成:<p& gt;<label for=”name”>姓名: </label>< input type=”text” id=”name” /></p>
- 能以背景形式呈现的图片, 尽量写入css样式中;
- 重要图片必须加上alt属性; 给重要的元素和截断的元素加上title;
- 给区块代码及重要功能加上注释, 方便后台添加功能;
- 书写页面过程中, 考虑向后扩展性;
css书写规范
- 编码统一为utf-8;
- 先根据各个模块, 同时根据页面相似程序, 事先写好大体框架文件base.css, 每个页面都要引入, 此文件包含reset及头部底部样式, 此文件不可随意修改;
- class与id的使用: id是唯一的并是父级的, class是可以重复的并是子级的, 所以id仅使用在大的模块上, class可用在重复使用率高及子级中;
- 为JavaScript预留钩子的命名, 以 js_ 起始, 比如: js_hide, js_show;
- class与id命名: 大的框架命名比如header/footer/wrapper/left/right之类必须统一命名.其他样式名称由 小写英文，数字，_ 来组合命名, 如i_comment, fontred, width200; 尽量使用简易的单词组合; 总之, 命名要语义化, 简明化.
- 子元素的class与id命名:
如, 要在页面代码<div id=”mainnav”></div>中加入新的div元素,
命名方法1: <div id=”mainnav”><div>…</div></div>,
样式写法: #mainnav .firstnav{…….}
命名方法:2 <div id=”mainnav”><div>…</div></div>,
样式写法: .main_firstnav{…….} - 合作时，对于重复使用率高的命名, 请以自己代号加下划线起始, 比如i_clear;
- 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等.
- 书写代码前, 考虑并提高样式重复使用率;
- 充分利用html自身属性及样式继承原理减少代码量, 比如:
<ul><li>这儿是标题列表<span>2010-09-15</span></ul>
定义ul.list li{position:relative} ul.list li span{position:absolute; right:0} - 样式表中中文字体名, 请务必转码成unicode码, 以避免编码错误时乱码;
- 背景图片请尽可能使用sprite技术, 减小http请求, 考虑到多人协作开发, sprite按模块制作;
- 使用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文件中要初始化表格样式)
- 杜绝使用<meta http-equiv=”X-UA-Compatible” content=”IE=7″ /> 兼容ie8;
- 用png图片做图片时, 要求图片格式为png-8格式,若png-8实在影响图片质量或其中有半透明效果, 请为ie6单独定义背景:
_background:none;_filter:progid:DXImageTransform.Microsoft.AlphaImageLoader(sizingMethod=crop, src=’img/bg.png’); - 避免不兼容属性的使用, 比如text-shadow || css3的相关属性;
- 为大区块样式添加注释, 小区块适量注释;
- 代码缩进与格式: 单行书写
JavaScript书写规范
- 文件编码统一为utf-8
- 库引入: 原则上仅引入jQuery库, 若需引入其它库, 须与团队其他人员讨论决定;
- 变量命名:原生JavaScript变量要求是纯英文字母, 首字母须小写, 如iTaoLun;
jQuery变量要求首字符为’_’, 其他与原生JavaScript 规则相同, 如: _iTaoLun;
另, 要求变量集中声明, 避免全局变量. - 类命名: 首字母大写. 如 ITaoLun;
- 函数命名: 首字母小写. 如iTaoLun();
- 命名语义化, 尽可能利用英文单词或其缩写;
- 尽量避免使用存在兼容性及消耗资源的方法或属性, 比如eval() & innerText;
- 后期优化中, JavaScript非注释类中文字符须转换成unicode编码使用, 以避免编码错误时乱码显示;
- 代码结构明了, 加适量注释. 提高函数重用率;
- 注重与html分离, 减小reflow, 注重性能.
图片规范
- 所有页面元素类图片均放入img文件夹, 测试用图片放于img/demoimg文件夹;
- 图片格式仅限于gif || png || jpg;
- 命名全部用小写英文字母 || 数字 || _ 的组合，其中不得包含汉字 || 空格 || 特殊字符；尽量用易懂的词汇, 便于团队其他成员理解; 另, 命名分头尾两部分, 用下划线隔开, 比如ad_left01.gif || btn_submit.gif;
- 在保证视觉效果的情况下选择最小的图片格式与图片质量, 以减少加载时间;
- 尽量避免使用半透明的png图片(若使用, 请参考css规范相关说明);
- 运用css sprite技术集中小的背景图或图标, 减小页面http请求, 但注意, 请务必在对应的sprite psd源图中划参考线, 并保存至img目录下.
注释规范
- html注释: 注释格式 <!–这儿是注释–>
- css注释: 注释格式 /*这儿是注释*/;
- JavaScript注释, 单行: //这儿是单行注释’ 多行: /* 这儿有多行注释 */
开发及测试工具约定
- 不可利用IDE的视图模式’画’代码;
- 不可利用IDE生成相关功能代码, 比如Dw内置的一些功能js;
- 编码必须格式化, 比如缩进;
- 测试工具: 前期开发仅测试FireFox & IE6 & IE7 & IE8 , 后期优化时加入Opera & Chrome;
- 建议测试顺序: FireFox–>IE7–>IE8–>IE6–>Opera–>Chrome, 安装firebug及IE Tab Plus插件.
其他规范
- 提高css复用率, 避免重复开发;
- 减小沉冗代码, 书写所有人都可以看的懂的代码. 简洁易懂是一种美德. 为用户着想, 为服务器着想。
如何提高代码编写效率
1、保持一贯性。
就像其它的任何事一样，值得一直保持一贯性。保持连贯性，而不是想到什么就给id和class命名什么。
CSS的级联样式有利于加深你的记忆，而且充分利用样式的继承去设置样式表。
首先声明通用的部分的样式，然后继续声明不通用的。这样当你需要的时候更容易的去覆盖一个特定的样式。因为样式更易于阅读和更具逻辑性，你会发现编写CSS更迅速。
使用一种最是适合你的方式。
复位和覆盖
链接和类型
主要布局
二次布局结构
表单元素
杂项2、注释标题，日期和签名
当样式被重写的时候遇到问题，可以很方便的找到是原始样式的编写者。当设计模板或者主题的时候这也是一个很好的习惯。
稍等…什么是swatch colors（色板颜色）？根据多年的经验，我发现在样式表中添加通用颜色的列表注释，在开始编写代码和以后的维护代码都是好非常有帮助的。节省了你打开photoshop来取色的或者打开网站的风格指南文档的步骤。当你需要指定的蓝色，滚动到顶端的注释找到相关颜色代码复制即可。
3、整理出一套模板库
一旦你决定使用一种结构，删除不是多余的部分留下主框架并且保存一个通用样式模板以备以后使用。
同时你可以保存多种版本的模板已适应不同结构的网站。
如：2列布局、博客布局、等等…。Coda(苹果系统下的编辑器)http://www.panic.com/coda/ 有很强的编辑功能，让你的编写代码更加容易。其它的编辑器也有类试的功能，只要使用相同的批处理文件，就会工作很nicely。
如果每次都从头，尤其每次以相同的习惯和方法写一遍样式，会让人很抓狂。
4、使用有用的命名规则
尤其在我声明一个列的id同时将它们命名为col-alpha和col-beta的地方注意一下。为什么不叫col-left和col-right?
时常需要想想将来的编辑。
明年你可以需要重新设计你的网站并移动左右边栏。你不应该因为仅仅改变了位置而去重名你的html元素并重命名你的样式id。
当然，你只需要重新定义元素的左右列的位置并保持这id仍然为#col-left,但是就会产生让人困惑的问题？如果是叫left,不要指望它一直是实现居左的。这样在移动元素以后，不会给你太多的空间的命名方式。
CSS的优点之一就是让内容现实不同风格能力。你重构网站的时候，完全可以只是修改CSS而不去修改HTML。
因此，不要让因为CSS的名字而局限。通过使用更通用的命名约定并保持一致性。
给位置或者样式以固定的命名方式。如命名一个叫.link-blue的class将会让你麻烦不断，当客户要求你讲链接的蓝色改成橘色的时候将会让你的样式变的很凌乱不堪。
因此命名的规则建立在他们是什么，而不是他们看起来像什么。例如，
通用方面：.comment-deta > .comment-blue
约束方面：.post-title > .post-largefont
.comment-deta更通用，.post-title约束更少。5、使用连字符而不使用下划线
有些比较老的浏览器对取得带下划线的CSS会出现问题，或就是不支持下划线。
因此为了让代码拥有更好的向后兼容性，培养使用连字符成为一个习惯。使用#col-alpha 而别使用 #col_alpha。
6、避免重复定义
重复的属性尽可能避免重复定义，而需要分组定义元素的属性。如果您的h1和h2元素都是使用相同的字体大小、颜色、和边框等，他们完全和可以合并成组定义。
同时尽可能使用样式的简写方式。时常对一些相同定义的元素进行合并和定义使用简写。
详细写法：
简单写法：
你了解CSS解释中的顺时针上、下、左、右简写方式，这是相当重要。
另外，如果你的顶部和底部，或者左边和右边的属性是相同的，你只需要两个命名。
例子中意思是距离顶部和底部都是1em，距离左右都是0em。7、优化使样式轻量化。
使用好上边的提示，你才会真正的减少你的样式表的大小。越小越容易加载，越小越容易维护及更新。
尽可能采用分组，删除不需要的样式。另一种CSS常用简写：当值为零的时候，你可以不指定度量单位。如果边距设置为0，你不用定义成0px或者0em。无论测量单位是什么0都是0，同时CSS是可以识别的。
8、代码基于火狐编写，然后针对webkit内核浏览器和IE浏览器进行调整
首先解决CSS在火狐浏览器下的一些让人头疼的问题。如果CSS在火狐下都有问题，其它浏览器下更可能出现问题。
9、进行验证
请使用W3C的CSS验证器进行验证。如果你坚持认为你的布局没有什么可以修改的时候，你可以使用CSS验证器对找出错误会有很大帮助。
10、保持页面的整洁性
支持单独的浏览器使用单独的CSS独立的样式表，同时javascript需要的样式、服务器端需要的样式、评论的样式。这样就可以避免一些不必要的ie的hack。只有这样才会保证样式的整洁性和可管理性。