Question

我使用以下语法来评论我的代码，

/*
 * @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}

但是，我如何继续评论资产的属性本身就是一个价值。我理解这个问题可能有点偏离主题，但我只是想确保我的代码注释符合某种语法规则，而且我无法在这个问题上找到任何内容。

Answer 1

最有用的是将所有对象属性枚举为单独的参数。 [Bracket]可选属性，例如：

/**
 *
 * @param {Object} assets Description
 * @param {Object} assets.fruits Description
 * @param {Object} assets.fruits.rootPath Description
 * @param {Object} assets.fruits.images Description
 * @param {Object} [assets.humans] Description
 *
 */

请参阅JSDoc中的“带属性的参数”。 How to describe "object" arguments in jsdoc?也是{{3}}。

Answer 2

看看JSDoc。我相信这就是你要找的东西。我在我的项目中使用它，它遵循与您正在使用的模式相同的模式。除了它有一个工具，将为您生成文档。

https://github.com/jsdoc3/jsdoc

以下是实际文档：

http://usejsdoc.org/

Answer 3

您使用的注释语法看起来很像JSDoc

非常确定，typedef标记看起来合适。

如何在javascript中评论对象结构？

3 个答案: