JSDoc和JavaScript属性getter和setter

Question

我希望我的代码,如下所示,可以使用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; }
}

Answer 1

使用@type记录的JavaScript get和set存取.像下面这样的东西应该适用于JSDoc:

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

这会将每个属性记录为类型为的成员number.

Answer 2

您可以使用 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 )中这是可能的。可以堆叠多个文档块（一个用于 getter，一个用于 setter）：

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