如何在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生成的文档？

回答

相关问题