0

我正在研究相当繁重的客户端JavaScript应用程序,并正在寻找添加文档。我采用vsdoc风格,以便通过intellisense获取,但无法定义返回对象。返回元素为Javascript vsdocs

假设定义的函数为:

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

我想能够编写代码:

返回object()。和之后。请参阅intellisense中的'prop1'和'method' - 如果没有在其他地方定义对象,这是可能的吗?

我将如何定义返回对象?我一直在寻找文档here,但到目前为止它没有什么帮助。看看jQuery的vsdoc显示,他们几乎总是返回jQuery对象或简单的类型。放大vsdoc显示它们返回Object或未定义,然后解释文本中该对象的样子。

我可以使用///元素样式文档来定义返回对象的外观吗?有没有人有这样的例子?

回答

0

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

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

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

另请注意,vsdoc文件现在称为智能感知文件。然而这个概念仍然是一样的。

inteliisense

使用嵌入式评论:

+0

哇,你是绝对正确的!看起来我太过于复杂了。所以你会说,'记录'你的本地/应用程序JS代码没有真正的优势,真的应该更多地用于记录你可以分发jsdoc的API吗? –

+0

我更新了我的答案。虽然是间接的,但应该澄清你的问题。 –