JavaScript编码风格指南:一、基本的格式化

1.1 使用4个空格作为一个缩进层级。

1.2 语句结尾写分号。

1.3 代码单行长度不超过80个字符。

1.4 换行:

当一行长度达到了单行最大字符数限制时,就需要手动将一行拆成两行。通常会在运算符后换行,下一行将会增加两个层级的缩进。

//好的做法
if (isLeapYear && isFebruary && day == 29 && itsYourBirthday && 
        noPlans) {
    waitAnotherFourYears();
}

//不好的做法:第二行只有一个缩进
callAFunction(document, element, window, "some string value", true, 
    123, navigator);

//不好的做法:在运算符之前换行了
callAFunction(document, element, window, "some string value", true
    , 123,navigator);
    

这个规则有一个例外:当给变量赋值时,第二行的位置应当与赋值运算符的位置保持对其。例如:

var result = something + anotherThing + yetAnotherThing + someThingElse + 
             anotherSomethingElse;

1.5 空行

空行是常常被忽略的一个方面,通常来讲,代码看起来应当像一系列可读的段落,而不是一大段揉在一起。应该在下面这些场景中添加空行:

  • 在方法之间
  • 在方法中的局部变量和第一条语句之间
  • 在多行或单行注释之间
  • 在方法内的逻辑片段之间
  • 其他...

1.6 命名

“计算机科学只存在两个难题:缓存失败和命名。” ————Phil Karlton。

使用驼峰命名方法给变量和函数命名。如:anotherThing、yetAnotherThing。
链接:常用命名

1.6.1 变量和函数
遵守驼峰大小写命名法;
变量名:前缀应该是名词;
函数名:前缀应该是动词。如:

//好的写法
var count =10;
var myName = "Jwk";
var found = true;

//不好的写法:变量看起来像函数
var getCount = 10;
var isFound = true;

//好的写法
function getName() {
    return myName;
}

//不好的写法:函数看起来像变量
function theName() {
    return myName;
}

常用动词:(链接:更多

| can | 函数返回一个布尔值 |
| has | 函数返回一个布尔值 |
| is | 函数返回一个布尔值 |
| get | 函数返回一个非布尔值 |
| set | 函数用来保存一个值 |

1.6.2 常量

虽然JavaScript中并没有真正的常量的概念,但这并不能阻止开发者将变量作为常量。

约定使用大写字母和下划线来命名常量。例如:

if (count < MAX_COUNT) {
    doSomething();
}

1.6.3 构造函数

在JavaScript中,构造函数是前面冠以new运算符的函数,用来创建对象。例如,Object和RegExp。所以开发者创建自己的构造函数时,命名应该与本地语言保持一致,采用驼峰命名法。

驼峰命名分为大写和小写两种,例如anoherName和AnotherName,构造函数采用后一种大写模式,这样可以将构造函数从变量和普通函数中区分出来。

看下一段代码:

var me = Person("Nicholas");
var you = getPerson("Michael");

根据上面的约定,我们一眼可以看出来第一行出了问题,缺少new运算符,第二行看起来还ok。

1.7直接量

1.7.1 字符串

约定使用双引号包裹字符串。

约定不使用“\”来创建多行字符串,使用“+”代替。

1.7.2 数字

//整数
var count = 10;

//小数
var price = 10.0;
var price = 10.00;

//不推荐的小数写法:没有小数部分
var price = 10.;

//不推荐的小数写法:没有整数部分
var price = .1;

//不推荐的写法:八进制写法已经被弃用了
var num = 010;

1.7.3 null 和 undefined

这两个词经常会被搞混,邪门的是null === undefined 返回结果竟为true。

null :把他当做对象的占位符
undefined :没有被初始化的变量都有一个初始值,即undefined,表示这个变量等待被赋值。

1、如果你使用了一个可能赋值为一个对象的变量时,将其赋值为null。不要写声明了但未赋值的变量。

//好的做法
var person = null;
console.log(person === null);        //true
console.log(typeof person);          //"object"

//不好的做法,foo未被声明
var person;
console.log(typeof person);          //"undefined"
console.log(typeof foo);             //"undefined"

这样写就可以保证只有在一种情况下typeof才会返回“undefined”:当变量未声明时。

2、比较的时候注意,因为 undefined === null ,返回true

//不好的写法
var person;
if (person != null) {
    //...
}

1.7.4 对象直接量

最流行的做法是使用对象直接量方法替代传统的创建object实例再添加属性的做法。

//不好的写法
var book = new Object();
book.title = "编写可维护的 JavaScript";

//好的写法
var book = {
    title : "编写可维护的 JavaScript"
}

1.7.5 数组直接量

同对象直接量一样。

//不好的写法
var colors = new AArray("red", "green", "blue");

//好的写法
var color = [ "red", "green", "blue"];
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,847评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,208评论 1 292
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,587评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,942评论 0 205
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,332评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,587评论 1 218
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,853评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,568评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,273评论 1 242
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,542评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,033评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,373评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,031评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,073评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,830评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,628评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,537评论 2 269

推荐阅读更多精彩内容

  • 第1章 JavaScript 简介 JavaScript 具备与浏览器窗口及其内容等几乎所有方面交互的能力。 欧洲...
    力气强阅读 1,065评论 0 0
  • 本章内容 语法 数据类型 流控制语句 理解函数 3.1 语法 3.1.1 区分大小写 区分大小写 3.1.2 标识...
    闷油瓶小张阅读 661评论 0 0
  • FreeCodeCamp - Basic JavaScript 写在前面: 我曾经在进谷前刷过这一套题,不过当时只...
    付林恒阅读 16,300评论 5 28
  • 翻了翻手机相册,惊奇的发现,竟然没有自拍照!!!作为一个女生,竟然没有自拍,多么悲伤的消息。。。 接下来,事情变成...
    bobo屋阅读 169评论 2 0
  • 。。这么多年了,看清一个人还是得靠钱啊。。
    我是玛莎阅读 134评论 0 0