1 代码风格
1.1 缩进与换行
[强制] 使用 4 个空格做为一个缩进层级,不允许使用 2 个空格 或 tab 字符。
解释:对于非 HTML 标签之间的缩进,比如 script 或 style 标签内容缩进,与 script 或 style 标签的缩进同级。
<style>
/* 样式内容的第一级缩进与所属的 style 标签对齐 */
ul {
padding: 0;
}
</style>
<ul>
<li>first</li>
<li>second</li>
</ul>
<script>
// 脚本代码的第一级缩进与所属的 script 标签对齐
require(['app'], function (app) {
app.init();
});
</script>
[建议] 每行不得超过 120 个字符。
解释:过长的代码不容易阅读与维护。但是考虑到 HTML 的特殊性,不做硬性要求。
2 相关规范
HTML 作为描述网页结构的超文本标记语言,在百度一直有着广泛的应用。本文档的目标是使 HTML 代码风格保持一致,容易被理解和被维护。
2.2 命名
[强制] class 必须单词全字母小写,单词间以 - 分隔。
[强制] class 必须代表相应模块或部件的内容或功能,不得以样式信息进行命名。
<!-- good -->
<div class="sidebar"></div>
<!-- bad -->
<div class="left"></div>
[强制] 元素 id 必须保证页面唯一。
解释:同一个页面中,不同的元素包含相同的 id,不符合 id 的属性含义。并且使用 document.getElementById 时可能导致难以追查的问题。
[建议] id 建议单词全字母小写,单词间以 - 分隔。同项目必须保持风格一致。
[建议] id、class 命名,在避免冲突并描述清楚的前提下尽可能短。
<!-- good -->
<div id="nav"></div>
<!-- bad -->
<div id="navigation"></div>
<!-- good -->
<p class="comment"></p>
<!-- bad -->
<p class="com"></p>
<!-- good -->
<span class="author"></span>
<!-- bad -->
<span class="red"></span>
[强制] 禁止为了 hook 脚本,创建无样式信息的 class。
解释:不允许 class 只用于让 JavaScript 选择某些元素,class 应该具有明确的语义和样式。否则容易导致 CSS class 泛滥。
使用 id、属性选择作为 hook 是更好的方式。
[强制] 同一页面,应避免使用相同的 name 与 id。
解释:IE 浏览器会混淆元素的 id 和 name 属性, document.getElementById 可能获得不期望的元素。所以在对元素的 id 与 name 属性的命名需要非常小心。
一个比较好的实践是,为 id 和 name 使用不同的命名法。
<input name="foo">
<div id="foo"></div>
<script>
// IE6 将显示 INPUT
alert(document.getElementById('foo').tagName);
</script>
命名规范
驼峰式命名法介绍
- 驼峰式命名法由小(大)写字母开始,后续每个单词首字母都大写。
- 按照第一个字母是否大写,分为:
- ① Pascal Case 大驼峰式命名法:首字母大写。eg:StudentInfo、UserInfo、ProductInfo
- ② Camel Case 小驼峰式命名法:首字母小写。eg:studentInfo、userInfo、productInfo
变量
- 命名方法:小驼峰式命名法
- 命名规范:前缀应当是名词。(函数的名字前缀为动词,以此区分变量和函数)
- 命名建议:尽量在变量名字中体现所属类型,如:length、count等表示数字类型;而包含name、title表示为字符串类型
// 推荐
var maxCount = 10;
var tableTitle = 'LoginTable';
// 不推荐
var setCount = 10;
var getTitle = 'LoginTable';
函数
-
命名方法:小驼峰式命名法
-
命名规范:前缀应当是名词。(函数的名字前缀为动词,以此区分变量和函数)
-
命名建议:参考下表

// 是否可阅读
function canRead() {
return true;
}
// 获取名称
function getName() {
return this.name;
}
常量
- 命名方法:名称全部大写
- 命名规范:使用大写字母和下划线来组合命名,下划线用以分割单词
var MAX_COUNT = 10;
var URL = 'http://www.xxx.com';
构造函数
- 命名方法:大驼峰式命名法,首字母大写
function Student(name) {
this.name = name;
}
var st = new Student('tom');
类的成员
- 公共属性和方法:跟变量和函数的命名一样
- 私有属性和方法:前缀为_(下划线),后面跟公共属性和方法一样的命名方式
function Student(name) {
var _name = name; // 私有成员
// 公共方法
this.getName = function () {
return _name;
}
// 公共方式
this.setName = function (value) {
_name = value;
}
}
var st = new Student('tom');
st.setName('jerry');
console.log(st.getName()); // => jerry:输出_name私有变量的值
注释规范
单行注释
说明:单行注释以两个斜线开始,以行尾结束 语法:// 这是单行注释 使用方式:
单独一行://(双斜线)与注释文字之间保留一个空格。
在代码后面添加注释://(双斜线)与代码之间保留一个空格,并且//(双斜线)与注释文字之间保留一个空格
注释代码://(双斜线)与代码之间保留一个空格
// 调用了一个函数;1)单独在一行
setTitle();
var maxCount = 10; // 设置最大量;2)在代码后面注释
// setName(); // 3)注释代码
多行注释
说明:以/开头,/结尾
语法:/* 注释说明 */
使用方式:
若开始(/)和结束(/)都在一行,推荐采用单行注释
若至少三行注释时,第一行为/,最后行为/,其他行以开始,并且注释文字与保留一个空格
/*
* 代码执行到这里后会调用setTitle()函数
* setTitle():设置title的值
*/
setTitle();
函数(方法)注释
说明:函数(方法)注释也是多行注释的一种,但是包含了特殊的注释要求,参照 javadoc(百度百科)
更多注释内容,可参考JSDOC :http://usejsdoc.org
语法:
/**
* 函数说明
* @关键字
*/

/**
* 合并Grid的行
* @param {Grid} grid 需要合并的Grid
* @param {Array} cols 需要合并列的Index(序号)数组;从0开始计数,序号也包含。
* @param {Boolean} isAllSome 是否2个tr的cols必须完成一样才能进行合并。true:完成一样;false(默认):不完全一样
* @return void
* @author polk6 2015/07/21
* @example
* _________________ _________________
* | 年龄 | 姓名 | | 年龄 | 姓名 |
* ----------------- mergeCells(grid,[0]) -----------------
* | 18 | 张三 | => | | 张三 |
* ----------------- - 18 ---------
* | 18 | 王五 | | | 王五 |
* ----------------- -----------------
*/
function mergeCells(grid, cols, isAllSome) {
// Do Something
}
2.3 标签
[强制] 标签名必须使用小写字母。
<!-- good -->
<p>Hello StyleGuide!</p>
<!-- bad -->
<P>Hello StyleGuide!</P>
[强制] 对于无需自闭合的标签,不允许自闭合。
解释:常见无需自闭合标签有 input、br、img、hr 等。
<!-- good -->
<input type="text" name="title">
<!-- bad -->
<input type="text" name="title" />
[强制] 对 HTML5 中规定允许省略的闭合标签,不允许省略闭合标签。
解释:对代码体积要求非常严苛的场景,可以例外。比如:第三方页面使用的投放系统。
<!-- good -->
<ul>
<li>first</li>
<li>second</li>
</ul>
<!-- bad -->
<ul>
<li>first
<li>second
</ul>
[强制] 标签使用必须符合标签嵌套规则。
解释:比如 div 不得置于 p 中,tbody 必须置于 table 中。详细的标签嵌套规则参见HTML DTD中的 Elements 定义部分。
[建议] HTML 标签的使用应该遵循标签的语义。
解释:下面是常见标签语义
p - 段落
h1,h2,h3,h4,h5,h6 - 层级标题
strong,em - 强调
ins - 插入
del - 删除
abbr - 缩写
code - 代码标识
cite - 引述来源作品的标题
q - 引用
blockquote - 一段或长篇引用
ul - 无序列表
ol - 有序列表
dl,dt,dd - 定义列表
<!-- good -->
<p>Esprima serves as an important <strong>building block</strong> for some JavaScript language tools.</p>
<!-- bad -->
<div>Esprima serves as an important <span class="strong">building block</span> for some JavaScript language tools.</div>
[建议] 在 CSS 可以实现相同需求的情况下不得使用表格进行布局。
解释:在兼容性允许的情况下应尽量保持语义正确性。对网格对齐和拉伸性有严格要求的场景允许例外,如多列复杂表单。
[建议] 标签的使用应尽量简洁,减少不必要的标签。
<!-- good -->
<img class="avatar" src="image.png">
<!-- bad -->
<span class="avatar">
<img src="image.png">
</span>
2.4 属性
[强制] 属性名必须使用小写字母。
<!-- good -->
<table cellspacing="0">...</table>
<!-- bad -->
<table cellSpacing="0">...</table>
[强制] 属性值必须用双引号包围。
解释:不允许使用单引号,不允许不使用引号。
<!-- good -->
<script src="esl.js"></script>
<!-- bad -->
<script src='esl.js'></script>
<script src=esl.js></script>
[建议] 布尔类型的属性,建议不添加属性值。
<input type="text" disabled>
<input type="checkbox" value="1" checked>
[建议] 自定义属性建议以 xxx- 为前缀,推荐使用 data-。
解释:使用前缀有助于区分自定义属性和标准定义的属性。
<ol data-ui-type="Select"></ol>
3 通用 3.1 DOCTYPE
[强制] 使用 HTML5 的 doctype 来启用标准模式,建议使用大写的 DOCTYPE。
[建议] 启用 IE Edge 模式。
[建议] 在 html 标签上设置正确的 lang 属性。
解释:有助于提高页面的可访问性,如:让语音合成工具确定其所应该采用的发音,令翻译工具确定其翻译语言等。
3.2 编码
[强制] 页面必须使用精简形式,明确指定字符编码。指定字符编码的 meta 必须是 head 的第一个直接子元素。
<html>
<head>
<meta charset="UTF-8">
......
</head>
<body>
......
</body>
</html>
[建议] HTML 文件使用无 BOM 的 UTF-8 编码。
解释:UTF-8 编码具有更广泛的适应性。BOM 在使用程序或工具处理文件时可能造成不必要的干扰。
3.3 CSS 和 JavaScript 引入
[强制] 引入 CSS 时必须指明 rel="stylesheet"。
<link rel="stylesheet" href="page.css">
[建议] 引入 CSS 和 JavaScript 时无须指明 type 属性。
解释:text/css 和 text/javascript 是 type 的默认值。
[建议] 展现定义放置于外部 CSS 中,行为定义放置于外部 JavaScript 中。
解释:结构-样式-行为的代码分离,对于提高代码的可阅读性和维护性都有好处。
[建议] 在 head 中引入页面需要的所有 CSS 资源。
解释:在页面渲染的过程中,新的CSS可能导致元素的样式重新计算和绘制,页面闪烁。
[建议] JavaScript 应当放在页面末尾,或采用异步加载。
解释:将 script 放在页面中间将阻断页面的渲染。出于性能方面的考虑,如非必要,请遵守此条建议。
<body>
<!-- a lot of elements -->
<script src="init-behavior.js"></script>
</body>
[建议] 移动环境或只针对现代浏览器设计的 Web 应用,如果引用外部资源的 URL 协议部分与页面相同,建议省略协议前缀。
解释:使用 protocol-relative URL 引入 CSS,在 IE7/8 下,会发两次请求。是否使用 protocol-relative URL 应充分考虑页面针对的环境。
<script src="//s1.bdstatic.com/cache/static/jquery-1.10.2.min_f2fb5194.js"></script>
4 head
4.1 title
[强制] 页面必须包含 title 标签声明标题。
[强制] title 必须作为 head 的直接子元素,并紧随 charset 声明之后。
解释:title 中如果包含 ASCII 之外的字符,浏览器需要知道字符编码类型才能进行解码,否则可能导致乱码。
<head>
<meta charset="UTF-8">
<title>页面标题</title>
</head>
4.2 favicon
[强制] 保证 favicon 可访问。
解释:在未指定 favicon 时,大多数浏览器会请求 Web Server 根目录下的 favicon.ico 。为了保证 favicon 可访问,避免 404,必须遵循以下两种方法之一:
在 Web Server 根目录放置 favicon.ico 文件。
使用 link 指定 favicon。
<link rel="shortcut icon" href="path/to/favicon.ico">
4.3 viewport
[建议] 若页面欲对移动设备友好,需指定页面的 viewport。
解释:viewport meta tag 可以设置可视区域的宽度和初始缩放大小,避免在移动设备上出现页面展示不正常。
比如,在页面宽度小于 980px 时,若需 iOS 设备友好,应当设置 viewport 的 width 值来适应你的页面宽度。同时因为不同移动设备分辨率不同,在设置时,应当使用 device-width 和 device-height 变量。
另外,为了使 viewport 正常工作,在页面内容样式布局设计上也要做相应调整,如避免绝对定位等。关于 viewport 的更多介绍,可以参见 Safari Web Content Guide的介绍
5 图片
[强制] 禁止 img 的 src 取值为空。延迟加载的图片也要增加默认的 src。
解释:src 取值为空,会导致部分浏览器重新加载一次当前页面,参考:developer.yahoo.com/performance…
[建议] 避免为 img 添加不必要的 title 属性。
解释:多余的 title 影响看图体验,并且增加了页面尺寸。
[建议] 为重要图片添加 alt 属性。
解释:可以提高图片加载失败时的用户体验。
[建议] 添加 width 和 height 属性,以避免页面抖动。
[建议] 有下载需求的图片采用 img 标签实现,无下载需求的图片采用 CSS 背景图实现。
解释:产品 logo、用户头像、用户产生的图片等有潜在下载需求的图片,以 img 形式实现,能方便用户下载。 无下载需求的图片,比如:icon、背景、代码使用的图片等,尽可能采用 CSS 背景图实现。
6 表单
6.1 控件标题
[强制] 有文本标题的控件必须使用 label 标签将其与其标题相关联。
解释:有两种方式:
将控件置于 label 内。
label 的 for 属性指向控件的 id。
推荐使用第一种,减少不必要的 id。如果 DOM 结构不允许直接嵌套,则应使用第二种。
<label><input type="checkbox" name="confirm" value="on"> 我已确认上述条款</label>
<label for="username">用户名:</label> <input type="textbox" name="username" id="username">
6.2 按钮
[强制] 使用 button 元素时必须指明 type 属性值。
解释:button 元素的默认 type 为 submit,如果被置于 form 元素中,点击后将导致表单提交。为显示区分其作用方便理解,必须给出 type 属性。
<button type="submit">提交</button>
<button type="button">取消</button>
[建议] 尽量不要使用按钮类元素的 name 属性。
解释:由于浏览器兼容性问题,使用按钮的 name 属性会带来许多难以发现的问题。具体情况可参考此文。
6.3 可访问性 (A11Y)
[建议] 负责主要功能的按钮在 DOM 中的顺序应靠前。
解释:负责主要功能的按钮应相对靠前,以提高可访问性。如果在 CSS 中指定了 float: right 则可能导致视觉上主按钮在前,而 DOM 中主按钮靠后的情况。
<!-- good -->
<style>
.buttons .button-group {
float: right;
}
</style>
<div class="buttons">
<div class="button-group">
<button type="submit">提交</button>
<button type="button">取消</button>
</div>
</div>
<!-- bad -->
<style>
.buttons button {
float: right;
}
</style>
<div class="buttons">
<button type="button">取消</button>
<button type="submit">提交</button>
</div>
[建议] 当使用 JavaScript 进行表单提交时,如果条件允许,应使原生提交功能正常工作。
解释:当浏览器 JS 运行错误或关闭 JS 时,提交功能将无法工作。如果正确指定了 form 元素的 action 属性和表单控件的 name 属性时,提交仍可继续进行。
<form action="/login" method="post">
<p><input name="username" type="text" placeholder="用户名"></p>
<p><input name="password" type="password" placeholder="密码"></p>
</form>
[建议] 在针对移动设备开发的页面时,根据内容类型指定输入框的 type 属性。
解释:根据内容类型指定输入框类型,能获得能友好的输入体验。
<input type="date">
7 多媒体
[建议] 当在现代浏览器中使用 audio 以及 video 标签来播放音频、视频时,应当注意格式。
音频应尽可能覆盖到如下格式:
MP3
WAV
Ogg
视频应尽可能覆盖到如下格式:
MP4
WebM
Ogg
[建议] 在支持 HTML5 的浏览器中优先使用 audio 和 video 标签来定义音视频元素。
[建议] 使用退化到插件的方式来对多浏览器进行支持。
<audio controls>
<source src="audio.mp3" type="audio/mpeg">
<source src="audio.ogg" type="audio/ogg">
<object width="100" height="50" data="audio.mp3">
<embed width="100" height="50" src="audio.swf">
</object>
</audio>
<video width="100" height="50" controls>
<source src="video.mp4" type="video/mp4">
<source src="video.ogg" type="video/ogg">
<object width="100" height="50" data="video.mp4">
<embed width="100" height="50" src="video.swf">
</object>
</video>
[建议] 只在必要的时候开启音视频的自动播放。
[建议] 在 object 标签内部提供指示浏览器不支持该标签的说明。
<object width="100" height="50" data="something.swf">DO NOT SUPPORT THIS TAG</object>
8 模板中的 HTML
[建议] 模板代码的缩进优先保证 HTML 代码的缩进规则。
<!-- good -->
{if $display == true}
<div>
<ul>
{foreach $item_list as $item}
<li>{$item.name}<li>
{/foreach}
</ul>
</div>
{/if}
<!-- bad -->
{if $display == true}
<div>
<ul>
{foreach $item_list as $item}
<li>{$item.name}<li>
{/foreach}
</ul>
</div>
{/if}
[建议] 模板代码应以保证 HTML 单个标签语法的正确性为基本原则。
<!-- good -->
<li class="{if $item.type_id == $current_type}focus{/if}">{ $item.type_name }</li>
<!-- bad -->
<li {if $item.type_id == $current_type} class="focus"{/if}>{ $item.type_name }</li>
[建议] 在循环处理模板数据构造表格时,若要求每行输出固定的个数,建议先将数据分组,之后再循环输出。
<!-- good -->
<table>
{foreach $item_list as $item_group}
<tr>
{foreach $item_group as $item}
<td>{ $item.name }</td>
{/foreach}
<tr>
{/foreach}
</table>
<!-- bad -->
<table>
<tr>
{foreach $item_list as $item}
<td>{ $item.name }</td>
{if $item@iteration is div by 5}
</tr>
<tr>
{/if}
{/foreach}
</tr>
</table>
9 js规范
避免全局变量污染命名空间
全局变量定义:
-
在任何函数外面定义var语句:var a = 'value';
-
直接添加属性在全局对象上:window.a = 'value';
-
直接使用未经声明的变量:a = 'value';
-
避免方式:
-
采用闭包的立即执行的方式,不要污染全局变量;
(funcction(){ // to do ... })(window) -
定义一个全局变量的命名空间
为了避免全局变量的污染,尽可能创建一个全局变量,让其他对象和函数存在其中
var variate={ maxCount :'xxx', minCount :'xxx', canRead :function(){ } } -
注意:即使包在函数中的未经声明的变量,在函数执行过后也会变成全局变量
function XX(){ name = "abc" }; console.log("----"+window.name) //---- function XX(){ name = "abc" }; XX(); console.log(window.name) //abc function XX(){ var name = "123ed" }; XX(); console.log("----"+window.name) //---- -
在匿名自执行函数中使用严格模式
(function(){ 'use strict'; $(function() { // to do ... }); }());- 避免声明全局变量,尽可能在函数体顶部声明局部变量
-
== 和严格等===的区别
== equality 等同:两边值类型不同的时候,要先进行类型转换,再比较
=== identity 恒等:不做类型转换,类型不同的一定不等
下面的规则用来判断两个值是否===相等:
- 如果类型不同,就[不相等] 2.如果两个都是数值,并且是同一个值,那么[相等]; 例外的是,如果其中至少一个是NaN,那么[不相等] (判断一个值是否是NaN,只能用isNaN()来判断)
- 如果两个都是字符串,每个位置的字符都一样,那么[相等];否则[不相等]
- 如果两个值都是true,或者都是false,那么[相等]
- 如果两个值都引用同一个对象或函数,那么[相等];否则[不相等]
- 如果两个值都是null,或者都是undefined,那么[相等];否则[不相等]
下面的规则用来判断两个值是否==相等:
- 如果两个值类型相同,进行 === 比较。
- 如果两个值类型不同,他们可能相等。详细划分为:
- 如果一个是null、一个是undefined,那么[相等]。
- 如果一个是字符串,一个是数值,把字符串转换成数值再进行比较
- 如果任一值是 true,把它转换成 1 再比较;如果任一值是 false,把它转换成 0 再比较
- 如果一个是对象,另一个是数值或字符串,把对象转换成基础类型的值再比较。
对象转换成基础类型,利用它的toString或者valueOf方法
js核心内置类,会尝试valueOf先于toString;
例外的是Date,Date利用的是toString转换
非js核心的对象不适用 - 任何其他组合,都[不相等]。
IF真假判断
在一个 if 条件语句中使用变量或表达式时,会做真假判断。if(a == true) 不同于 if(a) 。后者的判断比较特殊,我们称其为真假判断。 这种判断会通过特殊的操作将其转换为 true 或 false,下列表达式统统返回 false:false、 0、 undefined、null、NaN、 ' '(空字符串) 变量赋值时的逻辑操作
逻辑操作符 || 和 && 也可被用来返回布尔值。 如果操作对象为非布尔对象,每个表达式将会被自左向右地做真假判断 基于此操作,最终总有一个表达式被返回回来,这在变量赋值时,可以用来简化代码
//不推荐
if(!x) {
if(!y) {
x = 1;
} else {
x = y;
}
}
//推荐
x = x || y || 1;
这一小技巧经常用来给方法设定默认的参数
a = a || 1;
b = b || 1;
语句块内的函数声明
切勿在语句块内声明函数,在 ECMAScript 5 的严格模式下,这是不合法的。函数声明应该在定义域的顶层。但在语句块内可将函数申明转化为函数表达式赋值给变量。
//不推荐 if (x) { function foo() {} } //推荐 if (x) { var foo = function() {}; }
this 关键字
它时而指向全局对象(大多数时),时而指向调用者的定义域(在 eval 中),时而指向 DOM 树中的某一节点(当用事件处理绑定到 HTML 属性上时),时而指向一个新创建的对象(在构造器中),还时而指向其它的一些对象(如果函数被 call() 和 apply() 执行和调用时),使用this时注意其使用场景 数组和对象字面量
用数组和对象字面量来代替数组和对象构造器。数组构造器很容易让人在它的参数上犯错
//不推荐
//数组
// Length is 3.
var a1 = new Array(x1, x2, x3);
// Length is 2.
var a2 = new Array(x1, x2);
// If x1 is a number and it is a natural number the length will be x1.
// If x1 is a number but not a natural number this will throw an exception.
// Otherwise the array will have one element with x1 as its value.
var a3 = new Array(x1);
// Length is 0.
var a4 = new Array();
//对象
var o = new Object();
var o2 = new Object();
o2.a = 0;
o2.b = 1;
o2.c = 2;
o2['strange key'] = 3;
//推荐
//数组
var a = [x1, x2, x3];
var a2 = [x1, x2];
var a3 = [x1];
var a4 = [];
//对象
var o = {};
var o2 = {
a: 0,
b: 1,
c: 2,
'strange key': 3
};
不要使用 eval()语句
不要使用 eval()语句,因为它存在安全隐患,导致脚本注入攻击,并且在不同的浏览器引擎下还有效率上的差异 不要在循环里面进行DOM操作
//推荐
var htmlString = "";
for(var i =0; i<length;i++){
htmlString += html;
}
$(“.class”).append(htmlString);
//不推荐
for(var i =0; i<length;i++){
$(“.class”).append(html);
}
减少js操作DOM
在js操作DOM的过程中,要避免频繁改动DOM结构,可以先使用字符串方式组装html代码,再插到DOM结构中去 使用事件委托
对于多个同性质同辈节点,避免逐个进行事件绑定。而应该利用冒泡原理,将事件委托给父节点。 事件委托要接近事件触发节点,避免将所有事件冒泡委托给body节点
//推荐
$("table").on("click","td",function(){
})
//不推荐
$("td").on("click",function(){
})
能用CSS实现不用JS实现
JS尽可能避免直接写在页面中,加快加载速度
使用jQuery缓存
在使用jQuery时,需要用缓存的方式,避免重复产生过多的jQuery对象
//推荐
var cached = $('#top');
cached.find('p.classA');
cached.find('p.classB');
//不推荐
$('#top').find('p.classA');
$('#top').find('p.classB');
使用jQuery链式写法
$('class').find('h3').eq(2).html('Hello');
####参考引用