web-dev-qa-db-ja.com

JSDoc 3タグでオブジェクトのプロパティを文書化する方法：@this

@paramタグを使用すると、プロパティをドキュメント化できます。

 /**
  * @param {Object} userInfo Information about the user.
  * @param {String} userInfo.name The name of the user.
  * @param {String} userInfo.email The email of the user.
  */

@thisタグのプロパティをどのように文書化しますか？

 /**
  * @this {Object} 
  * @param {String} this.name The name of the user.
  * @param {String} this.email The email of the user.
  */

プロジェクトに取り組んでいる誰かが知っているかどうか疑問に思っています。 （ドキュメントはまだ作成中です...）

thisjsdoc
36
Matt

インスタンスメンバーを文書化するには、@name Class#memberを使用します。

/**
  Construct a new component

  @class Component
  @classdesc A generic component

  @param {Object} options - Options to initialize the component with
  @param {String} options.name - This component's name, sets {@link Component#name}
  @param {Boolean} options.visible - Whether this component is vislble, sets {@link Component#visible}
*/
function Component(options) {
  /**
    Whether this component is visible or not

    @name Component#visible
    @type Boolean
    @default false
  */
  this.visible = options.visible;

  /**
    This component's name

    @name Component#name
    @type String
    @default "Component"
    @readonly
  */
  Object.defineProperty(this, 'name', {
    value: options.name || 'Component',
    writable: false
  });
}

その結果、ドキュメントのMembersセクションに、各メンバー、そのタイプ、デフォルト値、および読み取り専用かどうかがリストされます。

[email protected]によって生成される出力は次のようになります。

JSDoc3 output

以下も参照してください。

54
lazd

使用 @propertyタグは、オブジェクトの属性を説明します。

@paramは、メソッドまたはコンストラクターのパラメーターを定義するために使用されます。

@thisは、thisが参照するオブジェクトを定義するために使用されます。 JSDOC 3を使用した例を次に示します。

/**
* @class Person
* @classdesc A person object that only takes in names.
* @property {String} this.name - The name of the Person.
* @param {String} name - The name that will be supplied to this.name.
* @this Person
*/
var Person = function( name ){
    this.name = name;
};

JSDOC 3： https://github.com/jsdoc3/jsdoc

詳細： http://usejsdoc.org/index.html

詳細： http://code.google.com/p/jsdoc-toolkit/wiki/TagParam

5
Larry Battle

Jsdocは、クラスのコンストラクター内で、ドキュメント化されたプロパティがクラスのインスタンスに属していること自体を認識します。したがって、これで十分です：

/**
 * @classdesc My little class.
 *
 * @class
 * @memberof module:MyModule
 * @param {*} myParam Constructor parameter.
 */
function MyLittleClass(myParam) {
    /**
     * Instance property.
     * @type {string}
     */
    this.myProp = 'foo';
}

Jsdocで関数がクラスコンストラクターであることが明確でない場合は、@thisを使用して、thisが参照するものを定義できます。

/**
 * @classdesc My little class.
 *
 * @class
 * @memberof module:MyModule
 * @name MyLittleClass
 * @param {*} myParam Constructor parameter.
 */

// Somewhere else, the constructor is defined:
/**
 * @this module:MyModule.MyLittleClass
 */
function(myParam) {
    /**
     * Instance property.
     * @type {string}
     */
    this.myProp = 'foo';
}
1
Ignitor