代码开发规范

命名规范

不知道是谁的名言

任何人都可以写出计算机能够理解的代码，但是只有好的程序员才可以写出人能够理解的代码

好的代码看起来就像在读一个文章

变量名迭代

// bad

const fruit = ['apple', 'banana']



// ok

const fruitArr = ['apple', 'banana']



// good

const fruits = ['apple', 'banana']



// great

const fruitNames = ['apple', 'banana']



const fruits = [

    {name:'apple'},

    {name:'banana'}

]

写符合规范的命名

1. Const 表示常量应该是用全大写加下划线
2. Const 表示普通不会变的常量用大驼峰即可

有意义的命名

使用具有描述性质的名字

getUserPosts


// bad

getUserData

getUserInfo

用词应该精简， 但是首先需要保证语义

findUserByNameOrEmail

setUserLoginId

保证动词的一致性

常用的动词有

1. Get
2. Set
3. Read
4. Create
5. Add
6. Update
7. Reset
8. Delete
9. Remove

虽然有很多同义词， 但是应该选择一个保持使用下去

函数名

函数或者方法名应该尽量采用动词或者判断性的词汇。

getFullYear()

toString()

isArray()

布尔值

布尔值一般用下面的几种助动词开头

1. Can
2. Is
3. Has
4. Need

类名

类名一般用名词

class Car {}

// bad

class MakeCar{}