如何记录对象属性

How to document an object property?

本文关键字：对象 属性 记录 何记录      更新时间：2023-09-26

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

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

，点有这样的结构:

{
    x,
    y
}

是不是说点应该有x和y的属性?当然，我可以在描述中这样做，但我在寻找更好的方法，比如在参数中，我们可以这样做:

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

你可以创建一个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}
 */
相关文章：