如何在 Visual Studio Code 中查看 JSCode 生成的文档？
How do I view JSCode-generated documentation in Visual Studio Code?
我一直在用 Visual Studio 代码构建一个 Angular 2/Typescript 项目，并努力添加 JSDoc 注释块，但我现在想查看 JSDoc 输出。我可以安装和设置我自己的 JSDoc 生成系统，但鉴于 VSC 中所有良好的 GUI 支持，能够直接从 VSC 生成和查看 JSDoc 似乎是合理的。
我的 Google-Fu 一直让我失望；每次我寻找 "Generating JSDoc Output within Visual Studio Code" 我只是得到插件来生成 JSDoc 评论块。
是否有在 Visual Studio 代码中生成和查看 JSDoc 输出的方法？
我在 vscode 中发现 jsdocs 有用的地方是 intellisense。
说我有这个功能
/**
* This squares a function
* @param x takes this value and doubles it
*/
function myAwesomeFunction(x: number) {
return x *x;
}
然后 vscode 将在我尝试调用该函数时向我显示此描述性 jsdoc。
AFAIK 没有内置支持，但我认为没有必要，因为您可以轻松添加一个 运行 适当的 jsdoc 命令的任务。我不知道这是不是你所说的 "setting up your own JSDoc generation system"，但很快就完成了：
- 首先从终端安装 jsdoc 生成器：
npm install -g jsdoc（假设你有 node.js / npm）。
- 确定 jsdoc 需要哪些参数（参见 http://usejsdoc.org/about-commandline.html）
- 设置任务（例如从菜单：任务 -> 配置任务）- 请参阅 https://code.visualstudio.com/Docs/editor/tasks 了解更多信息（您甚至可以添加键盘快捷键）
- 使用您的 JSDocs 打开生成的 html 页面。
我一直在用 Visual Studio 代码构建一个 Angular 2/Typescript 项目，并努力添加 JSDoc 注释块，但我现在想查看 JSDoc 输出。我可以安装和设置我自己的 JSDoc 生成系统，但鉴于 VSC 中所有良好的 GUI 支持，能够直接从 VSC 生成和查看 JSDoc 似乎是合理的。
我的 Google-Fu 一直让我失望；每次我寻找 "Generating JSDoc Output within Visual Studio Code" 我只是得到插件来生成 JSDoc 评论块。
是否有在 Visual Studio 代码中生成和查看 JSDoc 输出的方法？
我在 vscode 中发现 jsdocs 有用的地方是 intellisense。
说我有这个功能
/**
* This squares a function
* @param x takes this value and doubles it
*/
function myAwesomeFunction(x: number) {
return x *x;
}
然后 vscode 将在我尝试调用该函数时向我显示此描述性 jsdoc。
AFAIK 没有内置支持，但我认为没有必要，因为您可以轻松添加一个 运行 适当的 jsdoc 命令的任务。我不知道这是不是你所说的 "setting up your own JSDoc generation system"，但很快就完成了：
- 首先从终端安装 jsdoc 生成器：
npm install -g jsdoc（假设你有 node.js / npm）。 - 确定 jsdoc 需要哪些参数（参见 http://usejsdoc.org/about-commandline.html）
- 设置任务（例如从菜单：任务 -> 配置任务）- 请参阅 https://code.visualstudio.com/Docs/editor/tasks 了解更多信息（您甚至可以添加键盘快捷键）
- 使用您的 JSDocs 打开生成的 html 页面。