代码规范
命名
驼峰命名
- 采用驼峰命名法
大驼峰命名：首字母大写
小驼峰命名：首字母小写
文件资源命名
- 文件名建议只用小写，不使用大写字母（为了提醒，某些说明文件可以使用大写，比如README）
- 文件名包含多个单词时，单词之间建议使用连词线（-）分割
- 引入资源使用相对路径，不要指定资源的具体协议（http，https）
<script src = "//cdn.com/a.js"></script>
- 1
变量命名
采用小驼峰命名法
命名规范：类型+对象描述的方式，如果没有具体的类型，就可以使前缀为名词
|
类型 |
小写字母 |
|
array |
a |
|
boolean |
b |
|
function |
fn |
|
int |
i |
|
object |
o |
|
regular |
r |
|
string |
s |
比如：var tableTitle = ‘LoginTable’
函数命名
命名方式：采用小驼峰命名方式（构造函数采用大驼峰命名）
命名规则：前缀为为动词
|
动词 |
含义 |
返回值 |
|
can |
判断是否可以执行某个动作（权限） |
函数返回一个布尔值，true为可执行 |
|
has |
判断是否含有某个值 |
函数返回一个布尔值 |
|
is |
判断是否为某个值 |
函数返回一个布尔值 |
|
get |
判断是否为某个值 |
函数返回一个非布尔值 |
|
set |
设置某个值 |
无返回值 |
//是否可以阅读function canRead(){
return true;}//获取姓名function getName(){
return this.name;}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
常量
命名方法：全部大写
命名规范：使用大写字母与下划线来组合命名，下划线用来分割单词
var MAX_COUNT = 10;var URL = 'http://www.baidu.com';
- 1
- 2
类的成员
公共属性与方法：同变量名命名方式
私有属性与方法：前缀为”_”
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');
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
注释规范
单行注释
- 单独一行：//（双斜线）与注释文字之间保留一个空格
- 在代码后面添加注释：//（双斜线）与代码之间保留一个空格，并且与注释文字保留一个空格
- 注释代码：//（双斜线）与代码之间保留一个空格
// 单独在一行setTitle(); // 在代码后面// setTitile();
- 1
- 2
- 3
多行注释
- 若开始与结束都在一行，推荐单行注释
- 若至少三行注释时，第一行为/，最后一行为*/，其他行都以开始，并且与注释文字保留一个空格
/*
* 我是多行注释
*/
- 1
- 2
- 3
函数注释
|
注释名 |
语法 |
含义 |
实例 |
|
@param |
@param 参数名 {类型描述} 描述信息 |
描述参数的信息 |
@param name {String} 传入名称 |
|
@return |
@return {返回类型} 描述信息 |
描述返回值的信息 |
@return {Boolean} true:可执行；false:不可执行 |
|
@author |
@author 作者信息[附属信息：如邮箱，日期] |
描述此函数的作者信息 |
@author 张三 2015/07/21 |
|
@version |
@version XX.XX.XX |
描述此函数的版本号 |
@version 1.0.3 |
|
@example |
@example示例代码 |
@example setTitle(‘测试’) |
如下 |
/**
@param grid {Number} 需要合并的行
@param cols {Array} 需要合并的列,下标index从0开始计数
@param isAllSome {Boolean} 是否可以合并，true：完全一样，false（默认）：不完全一样
@return void
*/
1.项目名称全部采用小写，以下划线分割。如my_project
2.目录命名全部采用小写，以下划线分割。有复数结构时，要采用复数命名法。
html
- 缩进使用soft tab（4个空格）；
- 嵌套的节点应该缩进；
- 在属性上，使用双引号，不要使用单引号；
- 属性名全小写，用中划线做分隔符；
- 不要在自动闭合标签结尾处使用斜线（HTML5 规范 指出他们是可选的）；
- 不要忽略可选的关闭标签，例：</li> 和 </body>。
自动闭合标签：
<meta>标签:设置页面元信息的
<base>:设置网页所有链接的相对目录(如根目录)的
<br>:换行
<hr>:水平线
<img>:图像
<input>:表单元素
<col>:在表格table中定义一个或多个列的属性
<frame>:定义框架的一个窗口（已遗弃）
<link>:定义文档与外部资源的关系的链接
<area>: 标签定义图像映射内部的区域（图像映射指的是带有可点击区域的图像）。
<param>:元素允许您为插入 XHTML 文档的对象规定 run-time 设置，也就是说，此标签可为包含它的
<object> 或者<applet> 标签提供参数。
<embed>: HTML5 中新增的,标签定义了一个容器，用来嵌入外部应用或者互动程序（插件）。
<keygen>:该对象提供了一个安全的方式来验证用户。
<source>: 标签为媒体元素（比如 和 ）定义媒体资源。
- 在页面开头使用这个简单地doctype来启用标准模式，使其在每个浏览器中尽可能一致的展现；按照惯例使用大写，<!DOCTYPE html>
- 应在html标签加上lang属性。这会给语音工具和翻译工具帮助，告诉它们应当怎样去发音和翻译。中文:zh-cn,英文:en-us；
- 字符编码：通过声明一个明确的字符编码，让浏览器轻松、快速的确定适合网页内容的渲染方式，通常指定为'UTF-8'。
- IE兼容模式：用 <meta> 标签可以指定页面应该用什么版本的IE来渲染；
<meta http-equiv="X-UA-Compatible" content="IE=Edge">
以上代码告诉IE浏览器，IE8/9及以后的版本都会以最高版本IE来渲染页面。
- 根据HTML5规范，通常在引入CSS和JS时不需要指明type，因为text/css和text/javascript分别时它们的默认值。
<link rel="stylesheet" href="code_guide.css">
<script src="code_guide.js"></script>
- 属性顺序应该按照特定的顺序出现以保证易读性;
class
id
name
data-*
src, for, type, href, value , max-length, max, min, pattern
placeholder, title, alt
aria-*, role
required, readonly, disabled
- HTML5并不需要声明取值的属性，元素上存在布尔属性表示真值，缺少属性表示false值。布尔属性不允许使用值“true”和“false”。要表示错误值，必须完全省略该属性。
<input type="text" disabled>
- 在JS文件中生成标签让内容变得更难查找，更难编辑，性能更差。应该尽量避免这种情况的出现。
- 在编写html代码时，需要尽量避免多余的父节点，很多时候需要通过迭代和重构来使HTML变得更少。
<!-- Not well -->
<span class="avatar">
<img src="...">
</span>
<!-- Better -->
<img class="avatar" src="...">
尽量遵循HTML标准和语义，但是不应该以浪费实用性作为代价；任何时候都要用尽量小的复杂度和尽量少的标签来解决问题。
CSS，SCSS
以下几种情况不需要空格：
- 属性名后
- 多个规则的分隔符','前
- !important '!'后
- 属性值中'('后和')'前
- 行末不要有多余的空格
以下几种情况需要空格：
空行
- 属性值前
- 选择器'>', '+', '~'前后
- '{'前
- !important '!'前
- @else 前后
- 属性值中的','后
- 注释'/*'后和'*/'前
需要换行的情况：
- '{'后和'}'前
- 每个属性独占一行
- 多个规则的分隔符','后
/* not good */
.element, .dialog {
...
}
/* good */
.element,
.dialog {
...
}
注释
注释统一用'/* */'（scss中也不要用'//'），具体参照右边的写法；
缩进与下一行代码保持一致；
可位于一个代码行的末尾，与代码间隔一个空格。
/* Modal header */
.modal-header {
...
}
/*
* Modal header
*/
.modal-header {
...
}
引号
- 最外层统一使用双引号；
- url的内容要用引号；
- 属性选择器中的属性值需要引号。
命名
- 类名使用小写字母，以中划线分隔
- id采用驼峰式命名
- scss中的变量、函数、混合、placeholder采用驼峰式命名
属性声明顺序
相关的属性声明按右边的顺序做分组处理，组之间需要有一个空行。
.declaration-order {
display: block;
float: right;
position: absolute;
top: 0;
right: 0;
bottom: 0;
left: 0;
z-index: 100;
border: 1px solid #e5e5e5;
border-radius: 3px;
100px;
height: 100px;
font: normal 13px "Helvetica Neue", sans-serif;
line-height: 1.5;
text-align: center;
color: #333;
opacity: 1;
}
颜色
颜色16进制用小写字母；
颜色16进制尽量用简写。
属性简写
属性简写需要你非常清楚属性值的正确顺序，而且在大多数情况下并不需要设置属性简写中包含的所有值，所以建议尽量分开声明会更加清晰；
margin 和 padding 相反，需要使用简写；
/* not good */
.element {
transition: opacity 1s linear 2s;
}
/* good */
.element {
transition-delay: 2s;
transition-timing-function: linear;
transition-duration: 1s;
transition-property: opacity;
}
媒体查询
尽量将媒体查询的规则靠近与他们相关的规则，不要将他们一起放到一个独立的样式文件中，或者丢在文档的最底部，这样做只会让大家以后更容易忘记他们。
SCSS相关
提交的代码中不要有 @debug；
声明顺序：
- @extend
- 不包含 @content 的 @include
- 包含 @content 的 @include
- 自身属性
- 嵌套规则
@import 引入的文件不需要开头的'_'和结尾的'.scss'；
嵌套最多不能超过5层；
@extend 中使用placeholder选择器；
去掉不必要的父级引用符号'&'。
杂项
- 不允许有空的规则；
- 元素选择器用小写字母；
- 去掉小数点前面的0；
- 去掉数字中不必要的小数点和末尾的0；
- 属性值'0'后面不要加单位；
- 同个属性不同前缀的写法需要在垂直方向保持对齐，具体参照下边的写法；
- 无前缀的标准属性应该写在有前缀的属性后面；
- 不要在同个规则里出现重复的属性，如果重复的属性是连续的则没关系；
- 不要在一个文件里出现两个相同的规则；
- 用 border: 0; 代替 border: none;；
- 选择器不要超过4层（在scss中如果超过4层应该考虑用嵌套的方式来写）；
- 发布的代码中不要有 @import；
- 尽量少用'*'选择器。
/* not good */
.element {
border-radius: 3px;
-webkit-border-radius: 3px;
-moz-border-radius: 3px;
background: linear-gradient(to bottom, #fff 0, #eee 100%);
background: -webkit-linear-gradient(top, #fff 0, #eee 100%);
background: -moz-linear-gradient(top, #fff 0, #eee 100%);
}
/* good */
.element {
-webkit-border-radius: 3px;
-moz-border-radius: 3px;
border-radius: 3px;
background: -webkit-linear-gradient(top, #fff 0, #eee 100%);
background: -moz-linear-gradient(top, #fff 0, #eee 100%);
background: linear-gradient(to bottom, #fff 0, #eee 100%);
}
JavaScript
缩进
使用soft tab（4个空格）。
单行长度
不要超过80，但如果编辑器开启word wrap可以不考虑单行长度。
分号
以下几种情况后需加分号：
- 变量声明
- 表达式
- return
- throw
- break
- continue
- do-while
空格
以下几种情况不需要空格：
对象的属性名后 前缀一元运算符后
以下几种情况需要空格：
- 二元运算符前后
- 三元运算符'?:'前后
- 代码块'{'前
- 下列关键字前：else, while, catch, finally
- 下列关键字后：if, else, for, while, do, switch, case, try, catch, finally, with, return, typeof
- 单行注释'//'后（若单行注释和代码同行，则'//'前也需要），多行注释'*'后
- 对象的属性值前
- for循环，分号后留有一个空格，前置条件如果有多个，逗号后留一个空格
- 无论是函数声明还是函数表达式，'{'前一定要有空格
- 函数的参数之间
- 后缀一元运算符前
- 函数调用括号前
- 无论是函数声明还是函数表达式，'('前不要空格
- 数组的'['后和']'前
- 对象的'{'后和'}'前
- 运算符'('后和')'前
空行
以下几种情况需要空行：
- 变量声明后（当变量声明在代码块的最后一行时，则无需空行）
- 注释前（当注释在代码块的第一行时，则无需空行）
- 代码块后（在函数调用、数组、对象中则无需空行）
- 文件最后保留一个空行
换行
换行的地方，行末必须有','或者运算符；
以下几种情况不需要换行：
下列关键字后：else, catch, finally 代码块'{'前
以下几种情况需要换行：
- 代码块'{'后和'}'前
- 变量赋值后
单行注释
双斜线后，必须跟一个空格；
缩进与下一行代码保持一致；
可位于一个代码行的末尾，与代码间隔一个空格。
多行注释
最少三行, '*'后跟一个空格，具体参照右边的写法；
建议在以下情况下使用：
- 难于理解的代码段
- 可能存在错误的代码段
- 浏览器特殊的HACK代码
- 业务逻辑强相关的代码
引号
最外层统一使用单引号。
// not good
var x = "test";
// good
var y = 'foo'
变量命名
- 标准变量采用驼峰式命名（除了对象的属性外，主要是考虑到cgi返回的数据）
- 'ID'在变量名中全大写
- 'URL'在变量名中全大写
- 'Android'在变量名中大写第一个字母
- 'iOS'在变量名中小写第一个，大写后两个字母
- 常量全大写，用下划线连接
- 构造函数，大写第一个字母
- jquery对象必须以'$'开头命名
var thisIsMyName;
var goodID;
var reportURL;
var AndroidVersion;
var iOSVersion;
var MAX_COUNT = 10;
function Person(name) {
this.name = name;
}
// not good
var body = $('body');
// good
var $body = $('body');
变量声明
一个函数作用域中所有的变量声明尽量提到函数首部，用一个var声明，不允许出现两个连续的var声明。
function doSomethingWithItems(items) {
// use one var
var value = 10,
result = value + 10,
i,
len;
for (i = 0, len = items.length; i < len; i++) {
result += 10;
}
}
函数
无论是函数声明还是函数表达式，'('前不要空格，但'{'前一定要有空格；
函数调用括号前不需要空格；
立即执行函数外必须包一层括号；
不要给inline function命名；
参数之间用', '分隔，注意逗号后有一个空格。
// no space before '(', but one space before'{'
var doSomething = function(item) {
// do something
};
function doSomething(item) {
// do something
}
// not good
doSomething (item);
// good
doSomething(item);
数组、对象
对象属性名不需要加引号；
对象以缩进的形式书写，不要写在一行；
数组、对象最后不要有逗号。
括号
下列关键字后必须有大括号（即使代码块的内容只有一行）：if, else, for, while, do, switch, try, catch, finally, with。
null
适用场景：
- 初始化一个将来可能被赋值为对象的变量
- 与已经初始化的变量做比较
- 作为一个参数为对象的函数的调用传参
- 作为一个返回对象的函数的返回值
不适用场景：
- 不要用null来判断函数调用时有无传参
- 不要与未初始化的变量做比较
undefined
永远不要直接使用undefined进行变量判断；
使用typeof和字符串'undefined'对变量进行判断。
// not good
if (person === undefined) {
...
}
// good
if (typeof person === 'undefined') {
...
}
jshint
- 用'===', '!=='代替'==', '!='；
- for-in里一定要有hasOwnProperty的判断；
- 不要在内置对象的原型上添加方法，如Array, Date；
- 不要在内层作用域的代码里声明了变量，之后却访问到了外层作用域的同名变量；
- 变量不要先使用后声明；
- 不要在一句代码中单单使用构造函数，记得将其赋值给某个变量；
- 不要在同个作用域下声明同名变量；
- 不要在一些不需要的地方加括号，例：delete(a.b)；
- 不要使用未声明的变量（全局变量需要加到.jshintrc文件的globals属性里面）；
- 不要声明了变量却不使用；
- 不要在应该做比较的地方做赋值；
- debugger不要出现在提交的代码里；
- 数组中不要存在空元素；
- 不要在循环内部声明函数；
- 不要像这样使用构造函数，例：new function () { ... }, new Object；
杂项
不要混用tab和space；
不要在一处使用多个tab或space；
换行符统一用'LF'；
对上下文this的引用只能使用'_this', 'that', 'self'其中一个来命名；
行尾不要有空白字符；
switch的falling through和no default的情况一定要有注释特别说明；
不允许有空的代码块。