使用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){
   }
}