如何在Visual Studio代碼中查看JSCode生成的文檔？

我一直在Visual Studio代碼中構建Angular 2/Typescript項目，並且刻意添加JSDoc註釋塊，但我現在想查看JSDoc輸出。我可以安裝和設置我自己的JSDoc生成系統，但是如果在VSC中支持所有良好的GUI支持，似乎可以通過VSC生成和查看JSDoc。如何在Visual Studio代碼中查看JSCode生成的文檔？

我的Google-Fu讓我失望;每次我尋找「在Visual Studio代碼中生成JSDoc輸出」我只是得到插件來生成JSDoc註釋塊。

是否有在Visual Studio代碼中生成和查看JSDoc輸出的方法？

來源

2016-12-01 Daniel Griscom

你檢出了https://www.npmjs.com/package/tsdoc嗎？ – Digvijay

或... http://typedoc.org/api/ - 沒有看到任何擴展說每個人都可以從終端做什麼... – JGFMK

按Ctrl + Shift + O鍵查看所有的方法當您選擇一個方法並將鼠標懸停在該方法上時，相應的JSDoc將打開。 – Manubhargav

AFAIK有支持沒有內置，但我不認爲這是必要的，因爲你可以很容易地添加將運行相應的jsdoc命令的任務。我不知道這是不是你所說的「建立自己的JSDoc發電系統」的意思，但它迅速完成：

首先從終端安裝jsdoc發生器：npm install -g jsdoc（假設你的node.js/npm）。
決定你需要jsdoc其參數（參見http://usejsdoc.org/about-commandline.html）
建立一個任務（例如，從菜單：任務 - >配置任務） - 見https://code.visualstudio.com/Docs/editor/tasks更多信息（你甚至可以添加一個快捷鍵）
用JSDoc打開生成的html頁面。

來源

2017-07-17 11:34:39

感謝：最佳答案。 –

我發現在vscode中有用的jsdocs的地方是intellisense。

說我有這個功能

/** 
* This squares a function 
* @param x takes this value and doubles it 
*/ 
function myAwesomeFunction(x: number) { 
    return x *x; 
}

然後vscode會告訴我這個描述jsdocs每當我嘗試並調用該函數。

來源

2017-07-14 18:11:24 seescode

良好的信息，我知道，但它確實是一個不同問題的答案（我可能會問，有一天）。謝謝！ –

如何在Visual Studio代碼中查看JSCode生成的文檔？

回答

相關問題