Js规范

命名规范^强烈推荐

提示

语义化，可读性强。

1. 变量名

   • 全局变量
   • 局部变量
   • 类变量
   • 函数变量

2. 构造函数（类）命名

首字母大写，驼峰命名

3. 普通函数

首字母小写，驼峰命名，内部函数命名'-'如：_getName

4. 前缀规范

根据项目团队需要增加，例如$->jquery

注释规范^强烈推荐

提示

好的注释使代码可读性更强。

// 单行注释
/**
 * 多行注释
 * /

正面例子

// 注释信息很多写在变量上方
let name = 'mkimq' // 注释信息少

// 函数参数超过2个或以上

/**
 * @Author: Mankeung
 * @description: 方法描述
 * @param {string} name 参数描述
 * @param {number} age 参数描述
 * @return {void} 返回
 */
function getUser(name, age) {
    ...
}

// 函数参数少于2个

// 方法描述 name [string] 参数描述
function getUser(name) {
    ...
}

// 方法描述
function  getUser() {
    ...
}

书写规范^必要

1. 公共组件维护者和各栏目WD都需要在文件头部加上注释说明

/*
 * @Description: 描述信息
 * @Author: 作者
 * @Date: 创建事件
 * @LastEditors: 最后更新作者
 * @LastEditTime: 最后修改时间
 */

/*
 * @Description: sidebar
 * @Author: Mankeung
 * @Date: 2022-03-02 16:01:40
 * @LastEditors: Mankeung
 * @LastEditTime: 2022-03-31 17:16:35
 */

介意借助编辑器自动生成

2. 空格换行使用

反面例子

.
.
.
let name=''
let num=1+2
if(num>3){...}
function get(){...}
.
.
.

正面例子

.
.
.

let name = ''
let num = 1 + 2

if (num > 3) {
    ...
}

function get() {
    ...
}

.
.
.

3. 变量

正面例子

// 全局变量
const globalName = ''

// 其他变量
const name = ''

// 常量全大写多个单词下换线分隔
const MAX = 111
const BASE_URL = '/api'

// 类
class Person {
    ...
}

// 函数
function getName() {
    ...

    function _setName() {
        ...
    }

    ...
}

4. 末尾分号使用

根据团队规定