返回 Javascript vsdocs 的元素答案

【问题标题】：Returns element for Javascript vsdocs返回 Javascript vsdocs 的元素
【发布时间】：2013-11-29 02:28:41
【问题描述】：

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

假设一个函数定义为：

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

我希望能够编写如下代码：

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

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

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

【问题讨论】：

【解决方案1】：

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

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

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

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

使用内联 cmets：

【讨论】：

哇，你说得对！看起来我把事情复杂化了。那么您是否会说“记录”您的本地/应用程序 JS 代码并没有真正的优势，并且真的应该更多地用于记录可以分发 jsdoc 的 API？
我更新了我的答案。虽然是间接的，但它应该可以澄清你的问题。