Question

我正在尝试描述对象参数。我有一个获取对象作为参数的方法，我想用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描述“params”内容？

Answer 1

由于intellisense由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的文档以寻求帮助。

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

1 个答案: