# JS规范

# 变量

命名方式：小驼峰

命名规范：名词

// bad
let setCount = 10

// good
let maxCount = 10

1
2
3
4
5

# 常量

# 基本类型的常量：

命名方式：全部大写

命名规范：多个单词时使用分隔符_

// bad
const serverErrorCode = 402

// good
const SERVER_ERROR_CODE = 402

1
2
3
4
5

# 引用类型的常量：

命名方式：全部大写

命名规范：（3类）value枚举、label枚举、value-label枚举

// good
const MODIFY_TYPE = {
    ADD: 1,
    EDIT: 2
}

const MODIFY_TYPE_MAP = {
    [MODIFY_TYPE.ADD]: '新增',
    [MODIFY_TYPE.EDIT]: '编辑',
}

const MODIFY_TYPE_LIST = [
    {
        value: MODIFY_TYPE.ADD,
        label: MODIFY_TYPE_MAP[MODIFY_TYPE.ADD]
    },
    {
        value: MODIFY_TYPE.EDIT,
        label: MODIFY_TYPE_MAP[MODIFY_TYPE.EDIT]
    }
]

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

# 函数

命名方式：小驼峰

命名规范：动词前缀

// bad
function userInfo() {

}

// good
function getUserInfo() {

}

1
2
3
4
5
6
7
8
9

# 类

命名方式：大驼峰

命名规范：名词

// bad
class person {}

// good
class Person {}

1
2
3
4
5

# 注释

# 单行

// 单行注释，带空格
let maxCount = 123

1
2

# 多行

/**
 * 多行注释
 * /

1
2
3

# 减少嵌套

确定条件为false时，尽早返回。经典使用场景：校验数据

// bad
if (condition1) {
    if (condition2) {

    }
}

// good
if (!condition1) return
if (!condition2) return

1
2
3
4
5
6
7
8
9
10

# 减少无义标记值

习惯使用常量进行自解释

// bad
type: 1 // 1-新增 2-修改

// good
const MODIFY_TYPE = {
    ADD: 1,
    EDIT: 2
}
type: MODIFY_TYPE.ADD

1
2
3
4
5
6
7
8
9

# 简洁表达式

// bad
if (name === '') {}
if (collection.length > 0) {}
if (notTrue === false) {}

// good
if (!name) {}
if (collection.length) {}
if (notTrue){}

1
2
3
4
5
6
7
8
9

# 分支较多处理

对于相同变量或表达式的多值条件，用switch代替if

// bad
if (type === 'object') {
    // ...
} else if (type === 'number' || type === 'boolean') {
    // ...
}

// good
switch(typeof type) {
    case 'object':
        // ...
        break
    case 'number':
    case 'boolean':
        // ...
        break
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

# 使用变量名自解释

逻辑复杂时，建议使用变量名自解释，而不是晦涩难懂的简写。

// bad
function (value) {
    return !helper.req(value) || this.entity.enVocabularyEntries.filter(item => item.vocabularyEntryName === value).length < 2
}

// good
function (value) {
    let entVocabularyList = this.entity.enVocabularyEntries
    let repeatCount = entVocabularyList.filter(item => item.vocabularyEntryName === value).length
    return !helper.req(value) || repeatCount < 2
}

1
2
3
4
5
6
7
8
9
10
11

# 使用函数名自解释

遵循单一职责的基础上，可以把逻辑隐藏在函数中，同时使用准确的函数名自解释。

// bad
if (modifyType === MODIFY_TYPE.ADD) {
    batchVariableAPI(data).then(() => {
        this.closeModal()
        this.$toast.show('添加变量成功')
    })
} else {
  updateVariableAPI(data).then(() => {
        this.closeModal()
        this.$toast.show('修改变量成功')
    })
}

// good
modifyType === MODIFY_TYPE.ADD ? this._batchVariable() : this._updateVariable()

_batchVariable() {
    batchVariableAPI(data).then(() => {
        this.closeModal()
        this.$toast.show('添加变量成功')
    })
}

_updateVariable() {
  updateVariableAPI(data).then(() => {
        this.closeModal()
        this.$toast.show('修改变量成功')
    })
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

# 解构默认值可能会失效

如果解构出来的变量非undefined的话，该变量不会使用默认值。

// bad
const { list = [] } = data // data.list可能不是undefined
let result = list.map(item => item * 2) // 可能报错：Uncaught TypeError: list.map is not a function

// good
const { list } = data
let result = (list || []).map(item => item * 2)

1
2
3
4
5
6
7

虽然这种做法可以解决问题，但最好的做法是和后端同学约定好接口返回的数据类型（尤其为空时），避免在前端做过多的安全判断。

← CSS规范 ESLint & Prettier规范 →