如何在jsdoc中使用@param

我知道這是一個愚蠢的問題，但我剛開始使用jsdoc，並且遇到了試圖生成doc文件的問題。如何在jsdoc中使用@param

我跟蹤了一些我在網上發現的例子，這些例子看起來基本相同，但由於某些原因，我無法生成我想要記錄的變量之一的文檔。

這是我的代碼。

/** 
*@fileOverview mainController ' main controller file' 
*@param Controller here 
*/ 
function (jQuery, Controller, JSONModel, Filter){ 
    ..... 
    }

@fileOverview工作的@param不，index.html文件沒有顯示任何有關它的信息，我看不出有什麼錯誤，第一部分。我肯定做錯了這裏，但我不知道是什麼

來源

2017-04-17 polaris

您是否嘗試過將參數名稱之間的連字符像'@param Controller - here'這樣的描述？ – peteb

，這不起作用，我只是在@param控制器之前試過，並沒有工作。另外，我注意到'@fileOverview'顯示爲綠色，因爲它是一個註釋，而'@param'顯示爲藍色，我不知道這是否重要。我需要將jsdoc包含在我的依賴項中嗎？ – polaris

試試這個：

/** 
* @fileOverview mainController ' main controller file' 
* @param {object} Controller here 
*/ 
function (jQuery, Controller, JSONModel, Filter){ 
..... 
}

（注意間距的變化）

來源

2017-04-17 18:29:57

沒有工作。文檔看起來很簡單，我正在做的似乎是這樣做的方式 – polaris

我想我不理解文檔，但我嘗試了以下，它似乎工作 /** *'@fileOverview mainController' '主控制器文件' * '@constructor' 評論 * '@參數'{}對象控制器這裏 */ 功能（jQuery的，控制器，JSONModel，濾波器）{ ..... } 然後當我調出index.html我可以擴展該函數並查看其參數 – polaris

如何在jsdoc中使用@param

回答

相關問題