|
文档
下面提供了一些基本的函数或者对象的描述方法:
总结(summary): 简短的表述此函数或者对象实现的目的 描述(description): 对于此函数或者类的简短的描述 返回(return): 描述此函数返回什么(并不包括返回类型) 基本函数信息
function(){ // summary: Soon we will have enough treasure to rule all of New Jersey. // description: Or we could just get a new roomate. // Look, you go find him. He don’t yell at you. // All I ever try to do is make him smile and sing around // him and dance around him and he just lays into me. // He told me to get in the freezer ’cause there was a carnival in there. // returns: Look, a Bananarama tape! }
对象函数信息
没有返回值描述
{ // summary: Dingle, engage the rainbow machine! // description: // Tell you what, I wish I was--oh my g--that beam, // coming up like that, the speed, you might wanna adjust that. // It really did a number on my back, there. I mean, and I don’t // wanna say whiplash, just yet, cause that’s a little too far, // but, you’re insured, right? }
函数的声明
在有的情况下,对于函数的调用和声明是隐义(invisible)的。在这种情况下,我们没有办法在函数中加入说明等(供程序调用)。如果您遭遇了这种情况,您可以使用一个类来封装函数。
注:此此方法只能在函数没有初始化的参数情况下。如过不是,则它们会被忽略。
dojo.declare( "foo", null, { // summary: Phew, this sure is relaxing, Frylock. // description: // Thousands of years ago, before the dawn of // man as we knew him, there was Sir Santa of Claus: an // ape-like creature making crude and pointless toys out // of dino-bones, hurling them at chimp-like creatures with // crinkled hands regardless of how they behaved the // previous year. // returns: Unless Carl pays tribute to the Elfin Elders in space.
} );
参数
简单类型 简单的类型的参数可以直接在函数参数定义中注释说明。 function(/*String*/ foo, /*int*/ bar)... 可变类型参数 下面是几个修饰符供参考: ? 可选参数 ... 说面参数范围不确定 [] 数组 function(/*String?*/ foo, /*int...*/ bar, /*String[]*/ baz)... 全局参数描述 如果你想增加一个描述,你可以将它们移至初始化块。 基本信息格式为: *关键字* 描述字段 ( *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 }
|