JavaScript和复杂对象描述的Visual Studio Intellisense文档

Question

我试图描述进出对象参数。 我有一个方法获取一个对象作为参数，我想描述它的intellisense，所以当他们使用我正在使用的库时，团队可以启用intellisense。

var getSomething(element, params) { 
      /// <summary>Function summary</summary> 
      /// <param name="element" type="jQuery">Valeur textuelle permettant le groupage</param> 
      /// <param name="params" type="Object">{autoCreate:boolean, sSomething:string}</param> 
    }; 

如何使用Intellisense for Microsoft Visual Studio来描述“参数”内容？

Answer 1

由于intellisense是由IDE提供的，因此语法取决于您使用的IDE。最常见的不过是从（http://usejsdoc.org/）

例如，要在的IntelliJ家庭（WebStorm，PhpStorm）承认，并将生成的文档的工具，JsDoc衍生，你的例子可以这样写：

/** 
* @param {jQuery} element Valeur textuelle permettant le groupage. PS: You need to define jQuery somewhere else 
* @param {Object} params 
* @param {boolean} params.autoCreate 
* @param {string} params.sSomething 
*/ 
var getSomething = function(element, params) { // (your previous syntax was invalid) 
}; 

我的建议太关注IDE的文档以寻求帮助。