如何在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代码中生成和查看JSDoc输出的方法？

Answer 1

AFAIK 没有内置支持，但我认为没有必要，因为您可以轻松添加一个运行适当 jsdoc 命令的任务。我不知道这是否是你所说的“建立自己的 JSDoc 生成系统”的意思，但它很快就完成了：

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 页面。