如何在javascript中評論對象結構？

我使用下面的語法來評論我的代碼，如何在javascript中評論對象結構？

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

開始，但我怎麼然後繼續評論說，資產的性質本身就是一種價值。我理解這個問題可能有點偏離主題，但我只想確保我的代碼註釋符合某種語法規則，並且我無法在此問題上找到任何內容。

來源

2013-05-31 user2251919

你在使用JSDoc嗎？ – Sethen

我不知道JSDoc是什麼，我有點不同了。 – user2251919

最具信息性的是枚舉所有對象屬性作爲單獨的參數。 [支架]可選屬性，e.g：

/** 
* 
* @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?。

來源

2013-05-31 18:05:18 paislee