如何在jsdoc中使用@param答案

【问题标题】：how to use @param in jsdoc如何在jsdoc中使用@param
【发布时间】：2017-04-18 02:29:57
【问题描述】：

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

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

这是我的代码。

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

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

【问题讨论】：

您是否尝试在参数名称和描述之间添加连字符，如@param Controller - here？
那行不通，我之前只尝试过@param Controller，但那行不通。另外，我注意到“@fileOverview”显示为绿色，因为它是评论，而“@param”显示为蓝色，我不知道这是否重要。我需要在我的依赖项中包含 jsdoc 吗？

标签： javascript jsdoc

【解决方案1】：

试试这个：

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

（注意间距变化）

【讨论】：

那行不通。文档看起来很简单，我正在做的似乎是这样做的方式
我想我没看懂文档，但我尝试了以下，它似乎工作 /** * '@fileOverview mainController' ' 主控制器文件' * '@constructor' cmets * '@ param' {object} Controller here */ function (jQuery, Controller, JSONModel, Filter){ ..... } 然后当我打开 index.html 时，我可以展开函数并查看它的参数