javascript - 如何在jsdoc中使用@param

标签 javascript jsdoc

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

我遵循了一些在网上找到的示例,这些示例似乎本质上是相同的,但由于某种原因,我无法为我想要记录的变量之一生成文档。

这是我的代码。

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

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

最佳答案

试试这个:

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

(注意间距变化)

关于javascript - 如何在jsdoc中使用@param,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/43457215/

相关文章:

javascript - 没有模板的 Backbone

javascript - 滚动时尝试使用 jquery 使内容淡入

javascript - NVD3 散点图圆半径

typescript - JSDoc 中 Google Apps 脚本在线与本地的类型表示法不兼容

javascript - 传入 ko.mapping.fromJS 的复杂对象

javascript - JSDoc 重载函数不适用于 TypeScript

javascript - 使用 Closure-Compiler 类型检查数组内容

javascript - 使用 JSDoc 记录原型(prototype)扩展函数

javascript - JSDoc 3 文档构造函数/类参数

javascript - 如何在 jQuery 中列出可排序网格列表的项目?