0

期待されるオブジェクトプロパティを使用してオブジェクトプロパティを文書化するにはどうすればよいですか？たとえば、オブジェクトがこれである場合：

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

そしてポイントはこの構造を持っていました：

{
    x,
    y
}

とにかく、ポイントにxプロパティとyプロパティが必要であると言うことはありますか？もちろん、説明でそれを行うことはできますが、次のように実行できるパラメータのように、より良い方法を探していました。

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

1 に答える 1

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}
 */
于 2011-11-25T17:16:35.140 に答える