如何在jsdoc中使用@param

时间:2017-04-17 18:25:22

标签: javascript jsdoc

我知道这是一个愚蠢的问题,但我刚开始使用jsdoc而且我在尝试生成doc文件时遇到了问题。

我已经按照我在网上找到的一些例子看起来基本相同,但由于某些原因,我无法为我想要记录的变量之一生成文档。

这是我的代码。

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

第一部分@fileOverview不起作用@param,index.html文件没有显示任何关于它的信息,我看不到任何错误。 我肯定在这里做错了但我不知道是什么

1 个答案:

答案 0 :(得分:2)

试试这个:

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

(注意间距变化)