腾讯Alloy团队代码规范

概述

我我的很看重代码规范，由于代码是写给别人看的，按规范写别人才更容易理解。以前苦于没有代码规范的资料，如今在github上面看到了腾讯Alloy团队的代码规范，因而学习了一下，并记录下我本身还没怎么注意的地方，供之后开发时参考，相信对其余人也有用。css

顺便说下，这里是腾讯Alloy团队推荐的sublime3配置。html

命名规则

文件命名所有采用小写方式，如下划线分隔，有复数结构时，要采用负数命名法。

HTML

属性名，使用双引号，不要使用单引号；全小写，用中划线作分隔符。
不要在自动闭合标签结尾处使用斜线。
doctype大写。
在html标签上加上lang属性。
声明一个明确的字符编码，一般指定为'UTF-8'。
用meta标签指定页面应该用什么版本的IE来渲染(好比content="IE=Edge")；
在引入CSS和JS时不须要指明type。
属性应该按照特定的顺序出现以保证易读性，class>id>name>data-*>src等
boolean属性不须要声明取值。
避免用js生成标签。
在编写HTML代码时，须要尽可能避免多余的父节点。

css，scss

属性声明顺序。
如下几种状况须要换行：(1)'{'后和'}'前(2)每一个属性独占一行(3)多个规则的分隔符','后。
注释统一用'/* */'（scss中也不要用'//'）。
最外层统一使用双引号。
类名使用小写字母，以中划线分隔；id采用驼峰式命名；scss中的变量、函数、混合、placeholder采用驼峰式命名。
颜色16进制用小写字母；颜色16进制尽可能用简写。
除了margin和padding，都不须要使用属性简写，尽可能分开声明。
尽可能将媒体查询的规则靠近与他们相关的规则，不要放进独立样式文件，也不要扔在底部。
@import 引入的文件不须要开头的'_'和结尾的'.scss'。
声明顺序：@extend；不包含 @content 的 @include；包含 @content 的 @include；自身属性；嵌套规则。
去掉小数点前面的0。
属性值'0'后面不要加单位。
同个属性不一样前缀的写法须要在垂直方向保持对齐，无前缀的标准属性应该写在有前缀的属性后面。
用 border: 0; 代替 border: none;
发布的代码中不要有 @import。
尽可能少用'*'选择器。

JavaScript

return后面须要加分号。
这些关键字后要留一个空格：if, else, for, while, do, switch, case, try, catch, finally, with, return, typeof。
'}'前须要换行。
单行注释缩进与下一行代码保持一致。
多行注释最少三行, '*'后跟一个空格。
最外层统一使用单引号。
这些字符串一概按这里的写法，不小写或大写：'ID'，'URL'，'Android'， 'iOS'。
构造函数，大写第一个字母
常量全大写，用下划线链接。
对象属性名不须要加引号；数组、对象最后不要有逗号。
永远不要直接使用undefined进行变量判断；使用typeof和字符串'undefined'对变量进行判断。
for-in里必定要有hasOwnProperty的判断。
不要在同个做用域下声明同名变量。
不要在一些不须要的地方加括号，例：delete(a.b)。
数组中不要存在空元素。(有疑问？？？)
换行符统一用'LF'，即'/n'。
对上下文this的引用只能使用'_this', 'that', 'self'其中一个来命名。
一个函数做用域中全部的变量声明尽可能提到函数首部，用一个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;
    }
}