《编写可维护的 JavaScript》笔记一

返回列表

读书笔记 | 小叉 | 2013年07月05日

【第1章 基本的格式化】

1.1 缩进层级

制表符 或 空格符(2个空格、4个空格、8个空格)

  • jQuery 核心风格指南(jQuery Core Style Guide)明确规定使用制表符缩进。

  • Dauglas Crockford 的 JavaScript 代码规范(Douglas Crockford's Code Conventions for the JavaScript Programming Language)规定使用4个空格字符的缩进。

  • SproutCore 风格指南(CproutCore Style Guide)规定使用2个空格的缩进。

  • Google 的 JavaScript 风格指南(Google JavaScript Style Guide)规定使用2个空格的缩进。          

  • Dojo 变成风格指南(Dojo Style Guide)规定使用制表符缩进。            


1.2 语句结尾

推荐不要省略分号


1.3 行的长度

将行的长度限定在80个字符


1.4 换行

当一行的长度达到单行最大字符数限制时,就需要手动将一行拆成两行。

  • 在运算符后换行,第二行追加两个缩进;

  • 例外:当给变量赋值时,第二行的位置应该和复制运算符的位置保持对齐。


1.5 空行

在方法之间;

在方法中的局部变量(local variable)和第一条语句之间;

在多行或单行注释之前;

在方法内的逻辑片段之间插入空行,提高可读性。


1.6 命名

小驼峰命名法(Camel Case):首字母小写,后续单词首字母大写

大驼峰命名法(Pascal Case):首字母及后续单词首字母都大写

匈牙利命名法:名字之前冠以类型标示符前缀,比如:sName 表示字符串,iCount 表示整数。(不推荐)


1.6.1 变量和函数

变量名应当总是遵守驼峰大小写命名法,并且命名前缀应当是名词。

对于函数和方法命名来说,第一个单词应该是动词,这里有一些使用动词场景的约定:

csn:函数返回一个布尔值

has:函数返回一个布尔值

is:函数返回一个布尔值

get:函数返回一个非布尔值

set:函数用来保存一个值


1.6.2 常量

使用大写字母和下划线来命名,下划线用以分隔单词。(源于C语言)


1.6.3 构造函数

使用大驼峰命名法,与内置构造函数(Object、RegExp)相同的命名法。

构造函数的命名也常常是名词,因为它们是用来创建某个类型的实例的。


1.7 直接量

字符串:统一双引号或单引号

数字:浮点数不要省略整数或小数部分,不要使用八进制写法

null:

  • 用来初始化一个变量,这个变量可能赋值为一个对象。

  • 用来和一个已经初始化的变量比较,这个变量可以是也可以不是一个对象。

  • 当函数的参数期望是对象时,用作参数传入。

  • 当函数的返回值期望是对象时,用作返回值传出。

例子1:

var person;
console.log(typeof person); //"undefined"
console.log(typeof foo); //"undefined"

例子2:

var person=null;
var foo;
console.log(typeof person); //"object"
console.log(typeof foo); //"undefined"

undefined:避免在代码中使用 undefined

对象直接量:使用花括号取代显式地创建

数字直接量:使用方括号取代显式地创建

  1. 游客
    顶!d=====( ̄▽ ̄*)b
    2016-12-15 19:58:00
  2. 鸡蛋有毒
    顶一个
    2018-01-08 16:24:31

这里是小叉试验场的简版,请到正式版参与评论

下一篇:教你怎么把图标字体(IconFont)转为 PNG

上一篇:写给程序猿们的交互设计

返回列表