文档介绍：Web前端开发规范
规范目的
为输出高质量的Web页面,提高团队协作效率,便于后台人员添加功能及前端后期优化与维护,特制订此文档。本规范文档一经确认,前端开发人员必须按本文档规范进行前台Web页面开发。文档中如有错误或不当之处,由前端开发人员提出,经开发小组讨论决定后方可更改。
基本准则
符合W3C(万维网联盟Web标准,包括结构标准HTML、表现语言标准CSS、行为标准DOM和ECMAScript,必须通过W3C的HTML和CSS标准验证,网址为:
MarkUp Validator: http://validator./
CSS Validator: http://jigsaw./css-validator/
总体要求为:语义化HTML,结构表现与行为分离,浏览器兼容性优良,代码简洁明了有序,性能上尽可能减小服务器负载,保证最快的解析速度。
黄金定律
不管有多少人共同参与同一项目,一定要确保每一行代码都像是同一个人编写的。尽量遵循标准和语义,但是不要以牺牲实用性为代价。任何时候都要尽量使用最少的标签和元素并保持最小的复杂度。
文件规范
1、html,css,js,images,fonts等文件目录组织如下如示:
├──
├── css/
│├──
│├──
│└── images/
││├──
││└──
├── js/
│├──
│├──
└── images/
│├──
│└──
└── fonts/
└──
文件命名原则调整为所有字母小写,单词之间使用破折号(-)相连,压缩后的文件在原文件名(除扩展名)。参考bootstrap文件命名:bootstrap-, bootstrap-。
HTML书写规范
语法
用两个空格来代替制表符(tab) -- 这是唯一能保证在所有环境下获得一致展现的方法。
嵌套元素应当缩进一次(即两个空格)。
对于属性的定义,确保全部使用双引号,绝不要使用单引号。
不要在自闭和(self-closing)元素的尾部添加斜线-- HTML5 规范中明确说明这是可选的。
不要省略可选的结束标签(closing tag)(例如,</li> 或 </body>)。
<!DOCTYPE html>
<html>
<head>
<title>Page title</title>
</head>
<body>
<img src="pany-" alt="Company">
<h1 class="hello-world">Hello, world!</h1>
</body>
</html>
HTML5 doctype
为每个 HTML 页面的第一行添加标准模式(standard mode)的声明,这样能够确保在每个浏览器中拥有一致的展现。
<!DOCTYPE html>
<html>
<head>
</head>
</html>
语言属性
根据 HTML5 规范:强烈建议为 html 根元素指定 lang 属性,从而为文档设置正确的语言。这将有助于语音合成工具确定其所应该采用的发音,有助于翻译工具确定其翻译时所应遵守的规则等等。
<html lang="en-us">
<!-- ... -->
</html>
中文使用zh,。
IE 兼容模式
IE 支持通过特定的<meta> 标签来确定绘制当前页面所应该采用的 IE 版本。除非有强烈的特殊需求,否则最好是设置为 edge mode,从而通知 IE 采用其所支持的最新的模式。
<meta http-equiv="X-patible" content="IE=Edge">
字符编码
通过明确声明字符编码,能够确保浏览器快速并容易的判断页面内容的渲染方式。这样做的好处是,可以避免在 HTML 中使用字符实体标记(character entity),从而全部与文档编码一致(一般采用 UTF-8 编码)。
<head>
<meta charset="UTF-8">
</head>
引入 CSS 和 JavaScript 文件
根据 HTML5 规范,在引入 CSS 和 JavaScript 文件时一般不需要指定 type属性,因为 text/css 和 text/javascript 分别是它们的默认值。
<!-- External CSS -->
<link rel