我如何JSDoc @参数webstorm回调处理程序的参数？

Question

我想使用JSDoc暗示处理程序的参数，但它不起作用。我用@type和@param尝试过，它不起作用。官方的JSDoc没有包含任何有关这个问题的有用信息。

这不起作用：

socket.on("data", 
    /** 
    * @param request {Object} 
    * @param request.code {Number} 
    * @param request.id {Number} 
    * @param request.sr {String} 
    */ 
    function(request) 
    {}); 

Answer 1

您可以使用复杂的“类型定义”和“属性”标签。记录在：http://usejsdoc.org/tags-typedef.html 但是，“〜”字符似乎阻止WebIde链接类型注释。 （只需使用普通的typedef MyType的注释没有波浪和它的作品）

BTW，对于谷歌闭合方式：

/** @typedef {{code: Number, id: Number, str: String}} **/ 
SocketRequest; 

socket.on("data", handler); 

/** 
* @param {SocketRequest} req 
*/ 
function handler(req) { 
    //req will be hinted here 
} 

这jsdoc注释是专为谷歌关闭，但可以在不关闭使用贪图暗示。 （应该从2012年8月开始工作：http://blog.jetbrains.com/webide/2012/08/closure-syntax/）

Answer 2

这是含糊不清的问题，所以这里是我的猜测：

socket.on("data", 
/** 
* @param request {Object} 
* @param request.code {Number} 
* @param request.id {Number} 
* @param request.sr {String} 
*/ 
function(request) 
    typeof request.id == 'number'; 
    console.log(request.sr); // will print out the string 
{}); 

的评论只是描述了数据/密钥，应在请求对象的预期。

Answer 3

我认为你交换的对象的类型和名称，也许交换他们可以帮助？

这是jsdoc3，但我认为这是相同的：

http://usejsdoc.org/tags-param.html