文档介绍：前端开发规范
修订记录表
日期
修改者
版本号
修改说明
2013年4月19日
欧金峰
2013年7月1日
欧金峰
新增SEO规范
目录
1 概述 4
2 基本准则 4
3 规范 4
文件规范 4
html书写规范 5
css书写规范 6
javascript书写规范 7
图片规范 8
注释规范 8
开发及测试工具约定 9
4 其他
seo相关规则 9
概述
为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的文档, 特制订此文档. 本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发. 本文档如有不对或者不合适的地方请及时提出, 经讨论决定后方可更改.
基本准则
符合web标准, 语义化html, 结构表现行为分离, 兼容性优良. 页面性能方面, 代码要求简洁明了有序, 尽可能的减小服务器负载, 保证最快的解析速度.
规范
3 .1 文件规范
1. css文件命名: 英文命名, . , , 其他页面依实际模块需求命名.;
2. Js文件命名: 英文命名, . , 其他依实际模块需求命名.
html书写规范
文档类型声明及编码: 统一为html5声明类型<!DOCTYPE html>; 编码统一为<meta charset=”utf-8″/>, 书写时利用IDE实现层次分明的缩进;
非特殊情况下样式文件必须外链至<head>…</head>之间;非特殊情况下JavaScript文件必须外链至页面底部;
引入JS库文件, 文件名须包含库名称及版本号及是否为压缩版。
所有编码均遵循xhtml标准, 标签& 属性& 属性命名必须由小写字母及下划线数字组成, 且所有标签必须闭合, 包括br (<br />), hr(<hr />)等; 属性值必须用双引号包括;
充分利用无兼容性问题的html自身标签, 比如span, em, strong, optgroup, label,等等; 需要为html元素添加自定义属性的时候, 首先要考虑下有没有默认的已有的合适标签去设置, 如果没有, 可以使用须以”data-”为前缀来添加自定义属性,避免使用”data:”等其他命名方式;
尽可能减少div嵌套, 如<div class=”box”&amp;gt;<div class=”e”>欢迎访问XXX, 您的用户名是<div class=”name”&gt;用户名</div></div></div>完全可以用以下代码替代: <div class=”box”&gt;<p>欢迎访问XXX, 您的用户名是<span>用户名&lt;/span></p></div>;
书写链接地址时, 必须避免重定向,例如:href=”/”, 即须在URL地址后面加上“/”;
8. 在页面中尽量避免使用style属性,即style=”…”;
9. 能以背景形式呈现的图片, 尽量写入css样式中;
10重要图片必须加上alt属性; 给重要的元素和截断的元素加上title;
11给区块代码及重要功能(比如循环)加