javascript - 使用 JSDoc 记录成员函数

Question

我有这样的事情：

/**
Diese Klasse bla bla...
@constructor 
**/
my.namespace.ClassA = function(type)
{
   /**
   This function does something
   **/
   this.doSomething = function(param){
   }
}

该类将列在生成的文档中。该功能不会。有没有办法告诉 JSDoc (3) 这是类的成员函数ClassA？

Answer 1

尝试这个！

/**
  * Diese Klasse bla bla...
  * @constructor 
*/
my.namespace.ClassA = function(type)
{
   /**
    * This function does something
    * @function doSomething
    * @memberOf my.namespace.ClassA#
   */
   this.doSomething = function(param){
   };
};

JSDoc 在这方面似乎很笨拙：/ 关键是要指定 memberof 和函数的名称。另请参阅。

Answer 2

JSDoc 需要一些额外的信息来将函数识别为成员函数：

/**
  * Diese Klasse bla bla...
  * @constructor 
*/
my.namespace.ClassA = function(type)
{
   /**
    * This function does something
    * @function
    * @memberOf my.namespace.ClassA
   */
   this.doSomething = function(param){
   }
}

Answer 3

您需要使用全名路径显式描述该函数。有 3 种名称路径语法来描述函数：

Person#say  // the instance method named "say."
Person.say  // the static method named "say."
Person~say  // the inner method named "say."

请参阅此页面中的详细信息。