javascript - 返回 Javascript vsdocs 的元素

Question

我正在开发相当繁重的客户端 JavaScript 应用程序，并希望添加文档。我采用 vsdoc 风格以便被智能感知所接受，但在定义返回对象时遇到了麻烦。

假设一个函数定义为：

function returnObject() {
    return { 'prop1': 'value1', method: function(){return 1;}};
}

我希望能够将代码编写为：

返回对象（）。和之后。参见智能感知中的“prop1”和“method”——如果不在其他地方定义对象，这是否可能？

我将如何定义返回对象？我一直在查看文档here，但到目前为止帮助不大。查看 jQuery vsdoc 告诉我，它们几乎总是返回 jQuery 对象或简单类型。查看放大 vsdoc 表明它们返回 Object 或 undefined，然后解释该对象在文本中的样子。

我可以使用 /// 元素样式文档来定义返回对象的外观吗？有人有这个样本吗？

Answer 1

在 Visual Studio 2012+ 中，此场景不需要 vsdoc 文件。

vsdoc 适用于内部 javascript 解释器无法执行代码的情况，例如 Web 服务。

当在代码中使用 jsdoc 样式注释时，vsdoc 文件也很有用，并且您不希望在主代码文件中有 2 种注释格式。Jquery 就是一个很好的例子。

另请注意，vsdoc 文件现在称为智能感知文件。但是，概念仍然相同。

使用内联注释：