如何在JSDoc JSDoc中记录以下功能

Question

*如何在JSDoc JSDoc中记录以下功能*

我想在这个主函数中记录下和帮助方法，但是我没有弄清楚如何做到这一点。

/** 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已经就位，this应该能够自动推断。也许有些皱纹我没看见。

最后，我找到了两个对我有用的标签，@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>。

希望这能有所帮助！