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."

このページの詳細を参照してください。