12

以下のようなコードで、JSDoc（v2.4.0）を使用してオブジェクトリテラルの各プロパティを説明するドキュメントを生成できることを期待していましたが、機能しませんでした。JSDocを使用して、getter / setterを使用するコードからドキュメントを生成する方法を知っている人はいますか？

/** Enum of days of week. */
var Day = {
    /** Sunday. */
    get Sun() { return 0; },
    /** Monday. */
    get Mon() { return 1; },
    /** Thuesday. */
    get Tue() { return 2; },
    /** Wednesday. */
    get Wed() { return 3; },
    /** Thursday. */
    get Thu() { return 4; },
    /** Friday. */
    get Fri() { return 5; },
    /** Saturday. */
    get Sat() { return 6; }
}
4

2 に答える 2

19

@typeJavaScriptgetとsetアクセサーを文書化するために使用します。次のようなものがJSDocで動作するはずです。

    /**
     * Sunday.
     * @type {number}
     */
    get "Sun"() { return 0; },
    /**
     * Monday.
     * @type {number}
     */
    get "Mon"() { return 1; },

これは、タイプが。のメンバーとして各プロパティを文書化しますnumber。

于 2014-03-08T23:03:29.537 に答える
1

jQueryスタイルのgetter/setterメソッドを使用できます。

/**
 * Get colour of object
 * @returns {mixed}
 *//**
 * Set colour of object
 * @param {mixed} val
 * @returns {this}
 */
colour: function(val) {
    if (val === undefined)
       return this.colour;
    else {
       this.colour = val;
       return this;
    }
}

私はちょうどこの問題についてマイケル自身と話し合っています。非常に優れた機能により、jsDoc3（https://github.com/micmath/jsdoc ）で可能です。複数のdocblockをスタックすることができます（1つはgetter用、もう1つはsetter用）。

http://groups.google.com/group/jsdoc-users/browse_thread/thread/d4c7794bc8f6648e/94df7339e1fc4c91#94df7339e1fc4c91

于 2011-08-29T23:26:44.380 に答える