7

次の構文を使用してコードにコメントを付けています。

/*
 * @param variableName {variableType} Description
 * @return {returnType} Description
 */

しかし、パラメーターがオブジェクトであり、そのオブジェクトの辞書キーはそれ自体がパラメーターであり、そのキーの値であるため、オブジェクトのコンストラクターのコードにコメントする方法がわかりません。

パラメータの私の構造は以下のようなものです;

assets: {

    fruits: {

        rootPath: "files/fruits/",

        images: {

            apple: "apple.png",
            kiwi: "kiwi.png",
            orange: "orange.png",
            peach: "peach.png",
            pear: "pear.png",
            strawberry: "strawberry.png",
            watermelon: "watermelon.png"
        }
    },
    humans: {

        audio: {

            atari: "http://www.universal-soundbank.com/mp3/sounds/18534.mp3"
        }
    }
}

アセットはオブジェクトであるとコメントすることから始めました。

@param assets {Object}

しかし、資産のプロパティ自体が価値であるとコメントするにはどうすればよいでしょうか。この質問は少し的外れかもしれませんが、コードのコメントがある種の構文規則に準拠していることを確認したいだけで、この問題について何も見つけることができませんでした。

4

3 に答える 3

1

JSDocを見てください。これはあなたが探しているものです、私は信じています。私は自分のプロジェクトでこれを使用していますが、あなたが使用しているものと同じパターンに密接に従います。ドキュメントを生成するツールがあることを除いて。

実際のドキュメントは次のとおりです: Use JSDoc

于 2013-05-31T17:59:01.623 に答える
0

使用しているコメント構文はJSDocによく似ています。

私はかなり確信しています。typedefタグは適切に見えます。

于 2013-05-31T18:01:40.540 に答える