Dojo Style Javascript 编程规范（6）

参数

1. 简单类型

   简单的类型的参数可以直接在函数参数定义中注释说明。 function(/*String*/ foo, /*int*/ bar)...

2. 可变类型参数

   下面是几个修饰符供参考：

• ? 可选参数

• ... 说面参数范围不确定

• [] 数组 function(/*String?*/ foo, /*int...*/ bar, /*String[]*/ baz)...

3. 全局参数描述

   如果你想增加一个描述，你可以将它们移至初始化块。

基本信息格式为： *关键字* 描述字段 （ *key* Descriptive sentence）

参数和变量的格式为： *关键字* ~*类型*~ 描述字段 （ *key* ~*type*~ Descriptive sentence）

注： *关键字* 和 ~*类型*~ 可以使用任何字母和数字表述。
 

function (foo, bar) {
    // foo: String
    //          used for being the first parameter
    // bar: int
    //          used for being the second parameter
}

变量

由于实例变量、原型变量和外部变量的声明是一致的，所以有很多的方法声明、修改变量。具体的如何定义和定位应在变量最先出现的位置指明变量的名称、类型、作用域等信息。

function foo() {
    // myString: String
    // times: int
    //          How many times to print myString
    // separator: String
    //          What to print out in between myString*
    this.myString = "placeholder text";
    this.times = 5;
}
foo.prototype.setString = function (myString) {
    this.myString = myString;
}
foo.prototype.toString = function() {
    for(int i = 0; i < this.times; i++) {
        dojo.debug(this.myString);
        dojo.debug(foo.separator);
        }
}
foo.separator = "=====";