长期写代码，逐渐形成（或胁迫自己养成）一些特定的代码风格。一些普适性风格就没有必要在这里列出来，只列出那些可能与众不同，或者说在可左可右的情况下，在我的风格里胁迫自己选择其中一种。这份风格清单还会继续更新。它的主要依据有以下几点：

• 易于git diff阅读
• 少敲代码，键盘按键个数少、次数少和距离舒适
• 不故意加入反人类的风格，比如“逗号前置”
• 便于注释（主要针对条件分支语句）

1. 以换行而非分号结束语句

var a = 1
var b = 10

不想加分号的原因有：

1. javascript并不一定以分号作为语句的结束，虽然确实可以这样做，但是换行也可以做到，光是 “可以加分号但是大家都不加” 的语言就有：Go, Scala, Ruby, Python, Swift, Groovy...，所以我觉得写成没有分号的语句更好看。
2. 不以分号结束，有利于后期新增代码时，直接往下加即可。比如.pipe，如果要在之后再增加一个.pipe，只需要换行以后继续写.pipe即可，而不需要删除分号。
3. 在git中不会提示有分号那一行也被修改，有利于git commits的美观。

没有分号也让代码量变小，当然不利于Minify，但是一般Minify都是用工具做到的，都会自动加分号。

注意点

在特殊情况下，换行结束语句有问题：

Array.prototype.log = function() {
  console.log(this)
}
[1, 2, 3].log()

上面这段代码会报错，为什么呢？因为当使用function(){}[]这种形式的代码时，函数会被立即执行，这也是个坑，函数执行完之后得到一个返回值undefined，然后再执行undefined.log()赋值给Array.prototype.log，undefined.log()的地方自然就会报错。解决方案是：

在句首是 ( [ / + - 时在前面加分号

不过既然如此，那么在我的风格中，就应该禁止以([/+-作为句首，一般使用这些操作符作为行首都是想实现一些直接的运算，比如上面那段报错的代码，这虽然看上去简便了很多，但实际上这种运算在实践中意义不是很大，更多的是用在测试中。

实际上，这个问题的本质是对js语句的理解。一个语句会以怎样的方式开始？又会以怎样的方式结束？前一个问题理解透之后，再理解后一个问题作为补充。

javascript语句：

1. 表达式语句：a=b+c, d()
2. 复合语句和空语句：{}, ;
3. 声明语句：var, function
4. 条件判断语句：if, switch
5. 循环语句：for, while
6. 跳转语句：break, continue, return, throw
7. width、debugger和use strict

上面这些就是javascript的语句。大部分语句的开始都不会带来不写分号的问题，但是必须注意表达式语句。

以变量作为表达式语句的开头

例如:

a = 1
b = a + 1
c.log()
d ++
Math.abs(e)
window.log(f)

你可以看到，凡是以变量开头的表达式语句都不会造成上述分号问题。但是，如果像最开始的那段代码，先通过运算、操作、命令后在进行操作的类表达式，则需要谨慎：

('a' + 'b').split('')
[2, 4].join('')
(function(){})()

等等，这类语句也非常像表达式语句，但是它们的前提是先要进行运算后在进行操作。面对这类表达式语句，应该先赋值给变量后，在进行变量表达式操作：

var a = 'a' + 'b'
a.split('')
var b = [2, 4]
b.join('')
var c = function() {}
c()

当以变量开始语句时，就不会在发生上述问题。但是有的时候，你并不希望产生一个多余的变量，这种情况下，最好的办法就是在这种复杂表达式前面加分号;

几乎所有的分号问题，都是因为使用了复杂的表达式语句产生的。如果遵循了上面我提到的先变量赋值再进行简单表达式语句的话，就可以有效避免这个问题。

我以前觉得不敲分号会比较好看，但是现在看来会有一些问题，主要有两个：

• 我博客里的很多代码由于数据库迁移问题，导致代码换行失效，代码全部挤在一行里面了，而如果当初我坚持分号结束语句，那么及时出现了这个状况，还可以用格式化工具快速格式化代码，但是由于没有用分号，导致只能自己手敲。虽然这个情况在实际编码的时候很少遇到，但是多打一个分号在类似的情况下还是有好处。但是，即使有分号，如果代码中有行内注释//，换行丢失也会导致代码跑不了。
• 我是vscode重度用户，但是vscode会有一个代码提示功能，我又不喜欢空格结束语句，而打分号可以解决这个问题。

现在也比较纠结这个问题。

2. 用逗号分开的变量、参数、表达式，逗号后面空一格

var x, y
function a(x, y) {}
a(12, 14)
var [m, n, l] = [j, ...k]
stream.on('end', () => {})

3. 使用===而非==，!==同理，只有当希望发生类型转化时，才用==

if(typeof a === 'undefined') {}
if(0 == false) {} // 有的情况下，我不确定被判断值到底是0还是false，这时，可以通过==判断，但这时特殊情况，因此，当阅读到只有两个==时，我就会下意识问下自己，这里是不是肯定有类型转化

全等会判断数据类型，比如null和false就不全等，0和false也不全等。

4. 使用''引用字符串，使用``引用带变量的字符串，仅在html，json等有必要的地方使用""

var a = 'k'
var b = 'This is my first dog!'
var c = `Do you see a ${a} on the wall?`

之所以不适用双引号，主要是考虑打双引号要一只手按住shift键，另一只手按引号键。但是html中双引号更好，因为一些dom操作会使用双引号来添加属性。有些地方只能使用双引号，使用单引号还会引起一些错误，比如使用js去写一段嵌入式的shell时，这个时候，就需要在shell命令内部使用双引号。还有就是，像angular、vue这些模板中，会使用""作为一个作用域去运行js语句，外面使用双引号，那么里面就只能使用单引号，这样也可以保持js引号的使用一致性。

5. '{'前面有一个空格，函数的'('前面不要空格，其他'('要一个空格，')'后面要有一个空格，'}'后面应该换行，命令符不贴(，命令符关键字后面空格，函数名紧贴(

if (a === 10) {}
else {}
arr.forEach(item => {})

上面 else 一行换行遵循 '}'后面应该换行 并且有利于对整个block进行外部注释（比较讨厌Prettier将if的注释丢在外面，把else的注释丢到if的block中去）。

if () {} 
function get() {} 
get()
switch () {
  case '': {} // case关键字后面空格
}

其实{前面有空格，和下面的6也有关系，因为{前面总是那种后面需要跟空格的符号。但是也有例外，就是声明一个类的时候：class MyClass {}，这种情况下就体现了这条规则是必须的。

(跟在函数（或方法函数）后面，作为参数列表时，和函数名之间不需要有空格【这种用法由于1的原因，不会使用，只有在某些特定闭包才会使用】；但是跟在if, while等语句关键字后面时，加上一个空格。这使得我们很容易区分是js语言命令符，还是函数。

6. =, ==, !=, ===, !==, &&, ||, =>前后都有空格，但!后面不空格

var a = 10
if(a === 20) {}
setTimeout(() => {}, 1000)
if(!b) {}

7. ()内部紧贴表达式部分不留空格

if (a === b) {}
function c(go, to) {}

即使是使用了多层括号，也应该考虑通过换行的形式，而非空格的形式来处理。

8. 命名：普通变量、函数用驼峰，类用大写开头的驼峰，键名用_隔开的命名，常量用全大写和_隔开，文件名用全小写-隔开

var yourName = 'tom'
function runTask() {}
class MyTask {}
whiteHouse.set('left_color', 'grey')
const SOME_NAME = 'some name'

之所以不用连接线-作为连接符是因为，使用-的字符串无法直接作为属性名称，例如a['left-color']，而下划线则可以a.left_color。文件名杜绝使用大写，避免在linux环境下识别问题。

9. 冒号':'前面无需空格，后面要有一个空格

{
  age: 10,
}

代表数据类型的:后面不加空格

let a:string = 'ok'

10. 以逗号结尾的换行变量组中，最后一个变量加上逗号

var obj = {
  name: 'Nick',
  age: 10,
  sex: 'man',
}
function factory(
  arg1,
  arg2 = 10,
) {}

这样做也是和第一条有点像，如果要继续添加变量，只需要换行即可，不需要在最后一行添加一个逗号。声明变量不用逗号隔开的形式，而是全部用声明关键字换行声明，一行一个。

有些风格喜欢“逗号前置”的形式来处理这个点，比如：

var a = 10
    , b = 20
    , c = 30
var d, e, f

这样的好处是通过逗号分离的多个变量声明即使删掉最后一个，也不会造成错误。但是这种风格给人反人类的感觉，不喜欢，所以我的声明遵循11条。

11.声明时一个变量占一行，使用逗号一次性声明多个变量仅用在未赋值的变量，且至于一组声明的最后

var a = 1
var b = 2
var c, d, f

这样做的好处避免了上文提到的删掉最后一个声明变量时引起的问题。而如果想给某个原本未赋值的变量赋值时，git diff中会有两行变化，这也有利于我们看出来实际的改变情况。

12.if条件语句的中括号不可以省略；单条if...else赋值语句用?:代替

function() {
  ...
  if(xxx) return
  ...
  if(xxx) a = 1
  else a = 0
  a = xxx ? 1 : 0
  ...
}

13.代码缩进和tab使用两个空格

理由非常简单，tab不能直接使用\t，因为在不同的环境下，缩进距离会不一样，不使用4个空格是因为在一些条件下，我们需要手动输入空格来表示缩进，手动输入四个空格跟两个空格真是的不一样的体验。尽可能手动输入两个空格，而不是使用tab键（当然，如果IDE已经帮忙处理了，按一个键肯定比按两次舒服）。

14.数组的第一个和最后一个元素紧贴中括号，而对象大括号需要有一个空格

var a = [1, 2, 3, 4]
var o = { a: 1, b: 2 }

15.当一行代码太长，需要分行时，应该将连接符至于换行后第二行的开头

if (
  a === b
  && c === d
  && e === f
) {}
// 三元运算符在下文有专门的一条
var o = a === b 
  ? that 
  : theOne

之所以这样，是为了让看代码的人立即知道换行后第二行处于怎样的一个逻辑语句里面，如果不把连接符放在第二行句首，就不知道。而且这样还有一个好处，当删除最后一行时，语句仍然不报错。换行后应该缩进显示。

16.HTML标签属性换行时，属性要缩进，结束反中括号要换行

<div
  custom-attr="1"
  custom-attr2="2"
>
</div>

这条规则，这样可以在后期增加属性而不影响原有行，同时适用于JSX。

17. 一组值换行

• 数组内部结构复杂或元素较多时，应换行，换行后末位元素末尾加分号
• 对象内部结构复杂或超过2个属性，应换行，换行后末位元素末尾加分号
• 函数参数超过3个属性，应换行，换行后末位元素末尾加分号
• 函数传参数内部结构复杂或超过3个属性，应换行，换行后末位元素末尾加分号
• 声明变量组参考11条

// 结构简单且数量少，可以不用换行
[a, b, c] 
{ a, b, c }

// 结构复杂
[
  { id: 1 },
  { id: 2 },
]

// 数量多
{
  a: 1,
  b: 2,
  c: 3,
}

// 参数多
function (
  $scope,
  $rootScope,
  $state,
  $stateParams,
) {}

// 传参数复杂
save(
  'http...',
  (request) => {
    // ...
  },
  (response) => {
     // ...
  },
)

18. 只读属性或不稳定方法用 $ 开头，私有属性或方法 _ 开头

对于对象或类实例，不应该被修改（赋值）的属性用 $ 开头。以 $ 开头的方法，后期可能改使用方式，或者被删除，如果外部使用这些方法导致升级报错，我不负责任。私有属性或方法仅在我自己代码中调用，随时可能更换名字，不允许调用，要是调用私有属性或方法导致报错，概不负责。

19. switch...case 语句

switch (some) {
  case one: {}
  case tow: {}
  default: {}
}

和教科书上不同，我的 case 后面会加上 {} 来约束 case 后面的代码换行逻辑。

20. 三目运算符换行

const z = a > b ? x : m > n ? y : null
// 第一种换行：以:开头的换行
const z = 
  a > b ? x // 第一句
  : m > n ? y // 第二句
  : null // 第三句
// 上面换行等效于
let z = null
if (a > b) {
  z = x
}
else if (m > n) {
  z = y
}
else {
  z = null
}

// 第二种换行：在第二句及以后有子条件，此时，用括号扩起来，括号内遵循换行逻辑
const some = (
  a + b > c ? x
  : (
    d > e ? m
    : f > h ? m
    : null
  )
  : (
    l > n ? ok
    : g > j ? no
    : yes
  )
  : null
)

// 第三种换行：连续?换行
// 原始写法
const some = a + b > c ? (d > e ? m : f) : n
// 换行写法
const some = (
  a + b > c ? (
    // 此处连续两个?
    d > e ? m
    : f
  // 注意此处，eslint 要求将 ) : 放在一行，否则无法通过检查，但我们的写法不是按照该规则进行
  ) 
  : (
    g > h ? i
    : j
  )
)

之所以和eslint默认的换行逻辑不同，是因为这种换行方式我方便写注释，每一个?前面的是条件，后面的是该条件下的结果，所以，将?作为行内标记更方便注释这一行的内容。在eslint中，可通过配置indent规则的flatTernaryExpressions为true来实现这个效果。三目运算符换行时，要善用()，通过()可以有效的解决一些eslint报错问题。

21. 形状用type接口才用interface

type和interface的区别在于，interface可以（理论上也应该）被implement，如果我们仅仅是规定一个对象的结构，应该用type，而如果真的是在设计一个接口，希望被implement或extends，则应该使用interface。

2016-12-05 5301