用于 javascript 和复杂对象描述的 Visual Studio Intellisense 文档

Question

我正在尝试描述输入和输出对象参数。 我有一个将对象作为参数的方法，我想将其描述为智能感知，以便团队在使用我正在开发的库时启用智能感知。

    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

由于智能感知是由您的 IDE 提供的，因此语法取决于您使用的 IDE。然而，最常见的是来自输出生成文档的工具 JsDoc (http://usejsdoc.org/)

例如，要在 IntelliJ 家族（WebStorm、PhpStorm）中被识别，您的示例可以这样编写：

/**
 * @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 的文档以寻求帮助。