如何记录对象属性?

时间:2011-11-25 16:59:54

标签: javascript jsdoc

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

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

并且有这个结构:

{
    x,
    y
}

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

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

1 个答案:

答案 0 :(得分:2)

你总是可以成为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}
 */