web-dev-qa-db-ja.com

JSDocを使用してES6クラスのプロパティを文書化する方法

documentation package を使用していますが、ドキュメントクラスのプロパティ（ゲッターとセッターで定義されていない）を取得する方法がわかりません。

以下はSomeClassのクラスドキュメントを生成するだけですが、somePropertyドキュメントは省略しています。

/**
 * SomeClass is an example class for my question.
 * @class
 * @constructor
 * @public
 */
class SomeClass {
    constructor () {
        this.someProperty = true  // how do I document this?
    }

    /**
     * someProperty is an example property that is set to `true`
     * @property {boolean} someProperty
     * @public
     */
}

余談ですが：@constructorクラスjsdocは documentationthing です。

jsdoces6-class
7
balupton

JSDocを最初に定義されたコンストラクターに移動します。

/**
 * SomeClass is an example class for my question.
 * @class
 * @constructor
 * @public
 */
class SomeClass {
    constructor () {
        /**
         * someProperty is an example property that is set to `true`
         * @type {boolean}
         * @public
         */
        this.someProperty = true
    }
}

JSDocsをコンストラクターにインライン化することを含まないアプローチを使用して、 documentation package でそれを達成する方法があるかどうかはわかりません。

6
balupton