返回Javascript vsdocs的元素

Question

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

假设一个函数定义为：

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

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

returnObject（）。 和之后。 请参阅“智能感知”中的“ prop1”和“方法”-在其他地方不定义对象是否可能？

我将如何定义返回对象？ 我一直在这里查看文档，但到目前为止，它几乎没有帮助。 查看jQuery vsdoc可以看到，它们几乎总是返回jQuery对象或简单类型。 查看amplify vsdoc显示它们返回了Object或undefined，然后解释了该对象在文本中的外观。

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

Answer 1

在Visual Studio 2012+中，此方案不需要vsdoc文件。

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

vsdoc文件对于在代码中使用jsdoc样式注释时也很有用，并且您不想在主代码文件中使用2种注释格式。 jQuery是一个很好的例子。

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

使用内联注释：