我一直在 Visual Studio Code 中构建 Angular 2/Typescript 项目,并努力添加 JSDoc 注释 block ,但我现在想查看 JSDoc 输出。我可以安装和设置我自己的 JSDoc 生成系统,但鉴于 VSC 中所有良好的 GUI 支持,能够直接从 VSC 生成和查看 JSDoc 似乎是合理的。
我的 Google-Fu 一直让我失望;每次我寻找“在 Visual Studio Code 中生成 JSDoc 输出”时,我都会得到用于生成 JSDoc 注释 block 的插件。
是否有在 Visual Studio Code 中生成和查看 JSDoc 输出的方法?
最佳答案
据我所知,没有内置支持,但我认为没有必要,因为您可以轻松添加一个任务来运行适当的 jsdoc 命令。我不知道这是否是您所说的“设置您自己的 JSDoc 生成系统”的意思,但很快就完成了:
- 首先从终端安装 jsdoc 生成器:
npm install -g jsdoc
(假设您有 node.js/npm)。 - 确定 jsdoc 需要哪些参数(参见 http://usejsdoc.org/about-commandline.html)
- 设置任务(例如从菜单:任务 -> 配置任务)- 参见 https://code.visualstudio.com/Docs/editor/tasks了解更多信息(您甚至可以添加键盘快捷键)
- 使用您的 JSDocs 打开生成的 html 页面。
关于angular - 如何在 Visual Studio Code 中查看 JSCode 生成的文档?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/40915587/