javascript - 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 的成员。