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

Posted 2023-03-15

【中文标题】用于 javascript 和复杂对象描述的 Visual Studio Intellisense 文档

【英文标题】：Visual Studio Intellisense documentation for javascript and complex object description

【发布时间】：2013-11-02 19:54:00

【问题描述】：

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

    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 描述“参数”内容？

【参考方案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 的文档以寻求帮助。

【讨论】：

我指的是 Microsoft Visual Studio 的智能感知。我也使用 JSDocs，它运行良好，但 Microsoft 的智能感知不支持，因为它们有一个不同的符号（他们使用三斜杠 /// 并且它在函数内）。

我知道它们是不同的。我将为不使用VS的人留下答案。祝您获得对您有帮助的答案！