如何在 JSDoc JS-Toolkit 中记录以下功能

Question

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

我想在这个 ma​​in 函数中记录 try 和 help 方法 但我不知道该怎么做。

/** 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/* cmets，但我发现情况并非如此。和你一样，我使用标准的 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>。

希望这会有所帮助！