如何在javascript中注释对象结构?
我使用以下语法对代码进行注释如何在javascript中注释对象结构?,javascript,comments,Javascript,Comments,我使用以下语法对代码进行注释 /* * @param variableName {variableType} Description * @return {returnType} Description */ 但是我现在不知道如何对我的一个对象的构造函数的代码进行注释,因为参数是一个对象,而该对象的字典键本身就是一个参数,并且该键的值也是一个参数 我的参数结构如下所示 assets: { fruits: { rootPath: "files/fruits/",
/*
* @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}
但我如何继续评论资产的属性本身就是一种价值呢。我知道这个问题可能有点离题,但我只是想确保我的代码注释符合某种语法规则,我还没有找到任何关于这个问题的信息。看看JSDoc。我相信这就是你要找的。我在我的项目中使用它,它与您使用的模式非常相似。除了它有一个工具,可以为您生成文档 以下是实际文档:
您使用的注释语法与
可以肯定,标记看起来很合适。最有用的信息是将所有对象属性作为单独的参数枚举。[括号]可选属性,例如:
/**
*
* @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是什么,我已经编好了这个模式。