返回元素爲Javascript vsdocs

Question

我正在研究相當繁重的客戶端JavaScript應用程序，並正在尋找添加文檔。我採用vsdoc風格，以便通過intellisense獲取，但無法定義返回對象。

假設定義的函數爲：

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

我想能夠編寫代碼：

返回object（）。和之後。請參閱intellisense中的'prop1'和'method' - 如果沒有在其他地方定義對象，這是可能的嗎？

我將如何定義返回對象？我一直在尋找文檔here，但到目前爲止它沒有什麼幫助。看看jQuery的vsdoc顯示，他們幾乎總是返回jQuery對象或簡單的類型。放大vsdoc顯示它們返回Object或未定義，然後解釋文本中該對象的樣子。

我可以使用///元素樣式文檔來定義返回對象的外觀嗎？有沒有人有這樣的例子？

Answer 1

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

vsdoc適用於內部JavaScript解釋器無法執行代碼的情況，例如Web服務。

vsdoc文件在代碼中使用jsdoc樣式註釋時也很有用，並且您不希望主代碼文件中包含2種註釋格式。 Jquery就是一個很好的例子。

另請注意，vsdoc文件現在稱爲智能感知文件。然而這個概念仍然是一樣的。

使用嵌入式評論：