jsdoc - 如何在 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>.

希望这可以帮助！