如何在Visual Studio代码中查看JSCode生成的文档？

Question

我一直在Visual Studio Code中构建一个Angular 2 / Typescript项目，并且刻苦地添加了JSDoc注释块，但我现在想要查看JSDoc输出。我可以安装和设置我自己的JSDoc生成系统，但是在VSC中提供了所有良好的GUI支持，从VSC生成和查看JSDoc似乎是合理的。

我的Google-Fu一直让我失望;每当我寻找“在Visual Studio代码中生成JSDoc输出”时，我只需要插件来生成JSDoc注释块。

是否有在Visual Studio Code中生成和查看JSDoc输出的方法？

Answer 1

我发现在vscode中有用的jsdocs的地方是intellisense。

说我有这个功能

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

每当我尝试调用该函数时，vscode会向我显示这个描述性的jsdoc。

Answer 2

AFAIK没有内置支持，但我认为没必要，因为您可以轻松添加运行相应jsdoc命令的任务。我不知道这是不是你的意思＆＃34;设置你自己的JSDoc生成系统＆＃34;，但它很快就完成了：

1. 首先从终端安装jsdoc生成器：npm install -g jsdoc（假设你有node.js / npm）。
2. 确定jsdoc需要哪些参数（请参阅http://usejsdoc.org/about-commandline.html）
3. 设置任务（例如，从菜单：任务 - >配置任务） - 有关详细信息，请参阅https://code.visualstudio.com/Docs/editor/tasks（您甚至可以添加键盘快捷键）
4. 使用您的JSDocs打开生成的html页面。