详细介绍JavaScript 代码风格指南-tutorial js-php.cn

详细介绍JavaScript 代码风格指南

黄舟

Lepaskan： 2017-03-13 16:52:12

asal

1550 orang telah melayarinya

一.基本格式

缩进

建议每级4个空格，可以给编辑器设置tab = 4个空格，自动转换

分号

不要省略分号，防止ASI（自动插入分号）错误

行宽

每行代码不超过80个字符，过长应该用操作符手动断行

断行

操作符在上一行末尾，且下一行缩进2级，如果是赋值语句，还应该和等号后面部分对齐

空行

函数声明与函数声明、变量声明与函数声明、函数内部的逻辑块之间都应该有空行隔开

作者尼古拉斯还建议在流程控制块顶部留一个空行，但给的例子不是很明确

命名

变量名/函数名：Camel（驼峰）规则，首词首字母小写，后续词首字母大写，其余部分小写
常量名：C语言式，全大写，下划线分词
构造函数：Pascal规则，所有词首字母大写，其余部分小写

字面量

字符串：双引号包裹，断行用[+]操作符，不要用\转义字符
数值：不要省略小数点前后的部分，不要用八进制形式
Null：只把null当作Object的占位符，不要用来检测形参，也不要用来检测未初始化的变量
Undefined：应该把所有对象都初始化为null，以区分未定义和未初始化
对象字面量/数组字面量：不要用构造函数方式声明对象和数组

二.注释

P.S.书中有一句非常经典的解释：

Appropriately written comments help tell the story of code, allowing other developers to drop into a part of the story without needing to hear the beginning.

单行注释

行尾：用1级缩进隔开代码，而且//后面要有一个空格
独占一行：用来注释下面，要与被注释的代码保持相同的缩进
行首：用来注释多行代码

多行注释

用来包裹大段注释，推荐Eclipse风格，例如

/*
 * comment line1
 * comment line2
 */

Salin selepas log masuk

注意：

多行注释上方留一个空行
*星号后面留一个空格
多行注释至少三行（因为第一行和最后一行后面不加注释）

在哪里添注释

不能自解释的代码
故意的，但看起来像是有错的地方
针对浏览器的hack

文档注释

应该给各个函数添注释，包括功能描述、参数、返回值、抛出的错误等等，例如推荐的Eclipse风格：

/**
 * 添加指定元素到默认数组
 *
 * @method add
 * @param {Number} 将要添加的元素
 * @return {Boolean} 添加成功/失败
 * @throw {TypeError} 参数类型不匹配
 */
function add(item){
    if(typeof item === "number"){
        arr.push(item)
    }
    else{
        throw new TypeError();
    }
}

Salin selepas log masuk