如何在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

回答

相关问题