如何记录下面的函数在JSDoc JS-工具包

* 如何记录下面的函数在JSDoc JS-工具包*如何记录下面的函数在JSDoc JS-工具包

我想记录尝试和帮助方法在此主要功能但我没有弄清楚如何做到这一点。

/** Sample doc 
* @class 
* @constructor 
* @name Sample 
*/ 
var main=function(){ 
    this.value=""; 

    /** help function 
    * @param {String} Name 
    */ 
    this.help=function(name){ 
    console.log('help me'+name); 
    } 

    /** help function 
    * @param {String} Name 
    */ 
    this.try=function(name){ 
    console.log('try me'+name); 
    } 

}

来源

2013-04-05 Pradeep

我刚刚为此奋斗了几个小时。我想：

@member
@augments
@method
@this

从例子和教程我发现，成员函数和变量应该简单地出现在输出通过具有/** description/*以上的评论，但我发现并非如此。和你一样，我使用标准的JavaScript构造函数，其中this应该能够自动推断，因为@constructor已到位。也许我看不到一些皱纹。

最后，我发现了两个标签，对我而言，@name和@memberof。它们都允许您指定属性所属的对象。以这种方式使用@name没有记录（至少，我没有看到它在任何地方），但非常简单。您还需要使用@function。

下面是与@name标签的例子：

/** help function 
* @name Sample.try 
* @function 
* @param {String} Name 
*/ 
this.try=function(name){ 
    console.log('try me'+name); 
};

enter image description here

这里是一个与@memberof标签的例子：

/** help function 
* @memberof Sample 
* @function 
* @param {String} Name 
*/ 
this.try=function(name){ 
    console.log('try me'+name); 
};

enter image description here

正如你所看到的输出几乎相同。我看到的唯一区别是@memberof在方法名称中包含this.。出于这个原因，我已经决定使用@name。

剩下的问题是函数是每个实例，而不是<static>。

希望这会有所帮助！

来源

2013-06-19 14:21:55 mwcz

如何记录下面的函数在JSDoc JS-工具包

回答

相关问题