Dojo Style Javascript 编程规范（4）

空白

1. 操作符 建议 使用空格隔开（包括三元操作符）。

2. 下面的关键字 避免使用 空白隔开：

• break

• catch

• continue

• do

• else

• finally

• for 

• function （如果为匿名函数，例如：var foo = function(){}; ）

• if

• return

• switch

• this

• try

• void

• while

• with

3. 下面的关键字必须使用空白隔开：

• case

• default

• delete 

• function （如果为申明，例如：function foo(){}; ）

• in

• instanceof

• new

• throw

• typeof

• var

4. 逗号（,） 建议 使用空白隔开。

5. 冒号（:） 建议 使用空白隔开。

6. 点（.） 在后部 建议 使用空白隔开。

7. 点（.） 避免 在前部使用空白。

8. 函数调用和方法 避免 使用空白，例如： doSomething(someParameter); // 而非 doSomething (someParameter)

9. 逻辑块 之间使用空行。

10. 声明 建议 对齐使其更容易阅读。

注释

1. 生涩的代码就 没有必要 添加注释了，首先您需要 重写 它们。

2. 所有的注释请使用英文。

3. 从已解决的方案到未开发的功能，注释 必须 与代码相关。

4. 大量的变量申明后 必须 跟随一段注释。

5. 注释需要说明的是代码段的用处，尤其是接下来的代码段。

6. 注释 没有必要 每行都添加。

文档

下面提供了一些基本的函数或者对象的描述方法：

• 总结（summary）: 简短的表述此函数或者对象实现的目的

• 描述（description）: 对于此函数或者类的简短的描述

• 返回（return）: 描述此函数返回什么（并不包括返回类型）