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的文檔以尋求幫助。