如何在JSDoc JS-Toolkit中记录以下函数

Question

* 如何在JSDoc JS-Toolkit *

中记录以下函数

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

/** 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);
  }

}

Answer 1

我只是挣扎了好几个小时。我试过了：

• @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);
};

以下是@memberof标记的示例：

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

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

剩下的问题是函数是按实例进行的，而不是<static>。

希望这有帮助！