【问题标题】:How to document an object property?如何记录对象属性?
【发布时间】:2011-11-26 01:16:35
【问题描述】:

如何用预期的对象属性记录对象属性? 例如,如果对象是这样的:

var Object = {
    /**
     * 
     */
    point: null
}

这个点有这样的结构:

{
    x,
    y
}

有没有说点应该有 x 和 y 属性? 好吧,我当然可以在描述中做到这一点,但我正在寻找一种更好的方法来做到这一点,比如在我们可以这样做的参数中:

/**
 * @param {Object} point
 * @param {Number} point.x
 * @param {Number} point.y
 */

【问题讨论】:

    标签: javascript jsdoc


    【解决方案1】:

    你总是可以创建一个Point 类。

    function Point(x, y) {
        this.x = x;
        this.y = y;
    }
    

    然后

    var Object = {
        /**
         * new Point(x, y)
         * @param {Point} point a point class
         */
        point: null
    }
    

    否则我会这样做

    /*
     * @param {Object} point {x, y}
     */
    

    【讨论】:

    • 有时我不想有一个类定义,而其他对象需要在其属性中使用 cmets,从而使第二个选项无效。最好有像谷歌闭包那样的@typedef,在类列表中没有条目的情况下伪造一个类,但提供一个链接。不过还是谢谢!
    • 是的。我通常选择第二个选项并使用对象结构作为注释。
    猜你喜欢
    • 1970-01-01
    • 2021-02-09
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2018-07-24
    相关资源
    最近更新 更多