[关闭]
@brizer 2016-03-12T16:55:03.000000Z 字数 1181 阅读 1095

编写可维护的javascript第一章基本的格式化


前言

在项目实战的过程中,很多时候并不仅仅是开发新的功能,还需要在运营或交互的要求下对之前的代码进行维护的修改。如果代码在开发阶段没有可维护性和可拓展性,这个阶段就会变得异常复杂和耗时。

所以阅读本书,希望对自己进一步提升。


缩进

统一缩进的格式,我们定为4个空格。


语句结尾

分析器有自动分号插入机制,所以javascript代码省略分号也是可以正常工作的。但是为了避免一些问题,我们应该不省略分号。


行的长度

一般每行长度为80个字符,超过了则应该换行。


换行

针对单行太长,我们需要将一行拆成两行。通常我们会在运算符后换行,下一行会增加两个层级的缩进

将运算符置于尾部,是为了防止自动分号加入后出错。有一个例外,就是变量赋值时,第二行的位置应当和赋值运算符的位置保持对齐

  1. var result = something + anotherThing + yetAnotherThing +somethingElse +
  2. anotherSomethingElse;

空行

空行是为了增加代码的可阅读性。以下情况适合空行:
1. 方法之间
2. 方法中的局部变量和第一条语句之间
3. 多行或单行注释之前
4. 方法内的逻辑片段之间插入,提高可读性


命名

驼峰命名

变量和函数

变量名前缀是名词,函数名前缀是动词。举一些例子:

  1. var count;
  2. var myName;
  3. function getName();

需要避免没有意义的命名。对于函数和方法,前缀动词可以采取can,has,is,get,set等。

常量

ES6之前没有,但是可以将变量作为常量。其命名为大写字符加下划线:

  1. var MAX_COUNT;
  2. var URL;

构造函数

在javascript中,构造函数只不过是前面冠以new运算符的函数,用来创建对象。构造函数的命名遵循大驼峰命名法,也就是首字符大写的驼峰

  1. function Person(name) {
  2. this.name = name;
  3. }
  4. Person.prototype.sayName = function(){
  5. alert(this.name);
  6. };
  7. var me = new Person("lf");

直接量

javascript中包含一些类型的原始值:字符串、数字、布尔值、null和undefined。同样也包含对象直接量数组直接量

字符串

定义字符串时使用单引号或双引号,风格需要统一。可以使用\来编写多行字符串,但是最好还是利用+来拼接。

使用多行字符串会出现一个问题,就是\后面如果出现了多余字符比如空格,就会报错。

数字

不要省略整数部分或是小数部分。

null,undefined

两者区别可以看这篇文章

对象直接量

创建对象直接使用对象直接量,没有必要new一个Object()。

数组直接量

数组也是,不需要new一个Array(),可以直接用[]方法来新建。


感悟

本章都是一些基本的编程风格,不多言。

添加新批注
在作者公开此批注前,只有你和作者可见。
回复批注