来源:阮一峰
Douglas Crockford是Javascript权威,Json格式就是他的发明。
去年11月他有一个演讲(Youtube),谈到了好的Javascript编程风格是什么。
我非常推荐这个演讲,它不仅有助于学习Javascript,而且能让你心情舒畅,因为Crockford讲得很幽默,时不时让听众会心一笑。
下面,我根据这个演讲和Crockford编写的代码规范,总结一下”Javascript编程风格”。
所谓”编程风格”(programming style),指的是编写代码的样式规则。不同的程序员,往往有不同的编程风格。
有人说,编译器的规范叫做”语法规则”(grammar),这是程序员必须遵守的;而编译器忽略的部分,就叫”编程风格”(programming style),这是程序员可以自由选择的。这种说法不完全正确,程序员固然可以自由选择编程风格,但是好的编程风格有助于写出质量更高、错误更少、更易于维护的程序。
所以,有一点应该明确,“编程风格”的选择不应该基于个人爱好、熟悉程度、打字工作量等因素,而要考虑如何尽量使代码清晰易读、减少出错。你选择的,不是你喜欢的风格,而是一种能够清晰表达你的意图的风格。这一点,对于Javascript这种语法自由度很高、设计不完全成熟的语言尤其重要。
一、大括号的位置
绝大多数的编程语言,都用大括号({})表示区块(block)。起首的大括号的位置,有许多不同的写法。
最流行的有两种。一种是起首的大括号另起一行:
1 2 3 4 |
block { ... } |
另一种是起首的大括号跟在关键字的后面:
1 2 3 |
block { ... } |
一般来说,这两种写法都可以接受。但是,Javascript要使用后一种,因为Javascript会自动添加句末的分号,导致一些难以察觉的错误。
1 2 3 4 |
return { key:value; }; |
上面的代码的原意,是要返回一个对象,但实际上返回的是undefined,因为Javascript自动在return语句后面添加了分号。为了避免这一类错误,需要写成下面这样:
1 2 3 |
return { key : value; }; |
因此,
规则1:表示区块起首的大括号,不要另起一行。
二、 圆括号
圆括号(parentheses)在Javascript中有两种作用,一种表示调用函数,另一种表示不同的值的组合(grouping)。我们可以用空格,区分这两种不同的括号。
规则2:调用函数的时候,函数名与左括号之间没有空格。
规则3:函数名与参数序列之间,没有空格。
规则4:所有其他语法元素与左括号之间,都有一个空格。
按照上面的规则,下面的写法都是不规范的:
1 2 3 4 5 |
foo (bar) return(a+b); if(a === 0) {...} function foo (b) {...} function(x) {...} |
三、分号
分号表示语句的结束。大多数情况下,如果你省略了句尾的分号,Javascript会自动添加。
1 |
var a = 1 |
等同于
1 |
var a = 1; |
因此,有人提倡省略句尾的分号。但麻烦的是,如果下一行的第一个字元(token)是下面这五个字符之一,Javascript将不对上一行句尾添加分号:”(“、”[“、”/”、”+”和”-“。
1 2 3 4 |
x = y (function (){ ... })(); |
上面的代码等同于
1 |
x = y(function (){...})(); |
我非常推荐这个演讲,它不仅有助于学习Javascript,而且能让你心情舒畅,因为Crockford讲得很幽默,时不时让听众会心一笑。
下面,我根据这个演讲和Crockford编写的代码规范,总结一下”Javascript编程风格”。
所谓”编程风格”(programming style),指的是编写代码的样式规则。不同的程序员,往往有不同的编程风格。
有人说,编译器的规范叫做”语法规则”(grammar),这是程序员必须遵守的;而编译器忽略的部分,就叫”编程风格”(programming style),这是程序员可以自由选择的。这种说法不完全正确,程序员固然可以自由选择编程风格,但是好的编程风格有助于写出质量更高、错误更少、更易于维护的程序。
所以,有一点应该明确,“编程风格”的选择不应该基于个人爱好、熟悉程度、打字工作量等因素,而要考虑如何尽量使代码清晰易读、减少出错。你选择的,不是你喜欢的风格,而是一种能够清晰表达你的意图的风格。这一点,对于Javascript这种语法自由度很高、设计不完全成熟的语言尤其重要。
一、大括号的位置
绝大多数的编程语言,都用大括号({})表示区块(block)。起首的大括号的位置,有许多不同的写法。
最流行的有两种。一种是起首的大括号另起一行:
1 2 3 4 |
block { ... } |
另一种是起首的大括号跟在关键字的后面:
1 2 3 |
block { ... } |
一般来说,这两种写法都可以接受。但是,Javascript要使用后一种,因为Javascript会自动添加句末的分号,导致一些难以察觉的错误。
1 2 3 4 |
return { key:value; }; |
上面的代码的原意,是要返回一个对象,但实际上返回的是undefined,因为Javascript自动在return语句后面添加了分号。为了避免这一类错误,需要写成下面这样:
1 2 3 |
return { key : value; }; |
因此,
规则1:表示区块起首的大括号,不要另起一行。
二、 圆括号
圆括号(parentheses)在Javascript中有两种作用,一种表示调用函数,另一种表示不同的值的组合(grouping)。我们可以用空格,区分这两种不同的括号。
规则2:调用函数的时候,函数名与左括号之间没有空格。
规则3:函数名与参数序列之间,没有空格。
规则4:所有其他语法元素与左括号之间,都有一个空格。
按照上面的规则,下面的写法都是不规范的:
1 2 3 4 5 |
foo (bar) return(a+b); if(a === 0) {...} function foo (b) {...} function(x) {...} |
三、分号
分号表示语句的结束。大多数情况下,如果你省略了句尾的分号,Javascript会自动添加。
1 |
var a = 1 |
等同于
1 |
var a = 1; |
因此,有人提倡省略句尾的分号。但麻烦的是,如果下一行的第一个字元(token)是下面这五个字符之一,Javascript将不对上一行句尾添加分号:”(“、”[“、”/”、”+”和”-“。
1 2 3 4 |
x = y (function (){ ... })(); |
上面的代码等同于
1 |