代码规范

编码格式

如非特殊需要,项目默认编码格式统一为UTF-8格式

代码注释

文件注释

文件注释置于文件开头,用于描述文件作用及作者信息,必要时加入修改时间

/**
* 功能
* @author     richen
* @copyright  Copyright (c) 2017 - <richenlin(at)gmail.com>
* @license    MIT
* @version    17/4/27
*/

函数/方法注释

函数或方法注释置于函数或方法上方,主要描述函数或方法功能及参数说明,必要时增加使用详细说明

/**
* 功能
* @param brandid 品牌id
*/

单行注释

对代码块做简要说明

// 功能简要说明

代码分段及缩进

每段代码应放在一个代码块中。块内的代码都应统一地缩进一个单位。

使用TAB缩进

代码使用TAB键输入一次做为一个缩进单位。

function test() {
    //tab缩进一个单位
}

代码块符号

代码块开始符号 '{' 在行尾,不要单独一行。块结束符号 '}' 需要单独一行。

function test() { //块开始
    //...
} //块结束

空白行分隔

不同功能的单个或多个代码块之间使用空白行分隔。

function test() {
    ...... //相同功能代码块1

    ...... //相同功能代码块2

    ...... //相同功能代码块3
}

分号结束

代码语句结束,必须写分号!!

 xxxx ;  //分号不能省略

命名规则

文件命名

因操作系统差异,windows及mac文件名不区分大小写,而linux则区分大小写,为防止命名混乱。规范为:

1、文件名使用小写字母或数字加下划线'_'分隔

2、如果文件为服务类、控制器、模型类、中间件类,文件名和类名对于框架来说是一致的。

user_info.js  //框架中加载类名为 user_info

变量命名

1、尽量使用let定义。非必要尽量不使用var,防止全局污染

2、变量使用驼峰命名,由大小写字符及数字字符组成,不要使用特殊符号

3、命名时采用易被理解的英文组合,而非汉语拼音

const userName = '';

let age = '';

常量命名

1、使用const关键字定义

2、常量使用全大写字母,数字字符组成,使用'_'分隔。不要使用特殊符号

3、命名时采用易被理解的英文组合,而非汉语拼音

const PI = 3.1415;

函数/方法命名

1、函数或方法使用驼峰命名,不要使用特殊符号

2、内部方法使用 '_' 作为前缀标示

3、命名时采用易被理解的英文组合,而非汉语拼音

function callServer(param1, param2) {
    ......
}


class {
    _initName() {

    }

    getUser() {

    }
}