与你相遇好幸运,The Moe Node.js Code Style Guide

时间:2023-03-09 00:36:33
与你相遇好幸运,The Moe Node.js Code Style Guide

The Moe Node.js Code Style Guide  By 一个最萌的开发者 @2016.9.21

>>代码是人来阅读的,格式规范的代码是对编程人员最好的礼物 :)

>制表符和空格

我们选用和jslint规范一致的格式:两个空格

正确的:

if(true){
  console.log('hi');
}

>分号

每行语句的末尾使用分号结束

console.log('hi');

>编辑器

统一开发环境,文件编码无dom头的utf-8编码

>空行

删掉

>引号

统一使用单引号,万不得已时使用双引号

console.log('hi');

>大括号

遵循js代码规范

if(true){
}

>变量声明

小写,驼峰命名法

var username = 'default';

多变量声明时:

var username = 'user';

var passwd    = 'passwd';

var email       = 'user@me.com';

var phone     = 18812345678;

每行声明一个变量,等于号两边至少一个空格,等于号对齐

>配置变量声明

全部大写,以下划线分割

DEFAULT_DATABASE_NAME

>数组声明

写在单行内

var a = [1,2,3,4,5,6,7,8,9,0];

>对象声明

写在多行

var o = {

one:"one",

two:"two"

}

>回调函数

为你的回调函数起一个名称,为的是出错时的堆栈跟踪

req.on('end',function onEnd(){

})

>引入规范

首先引入系统库,其次npm库,其次项目文件,最后配置文件引入,不同层级间使用空格

var router = require('koa-router')();
var body = require('koa-body')();

var email = require('./v1/email');
var group = require('./v1/group');