WebStorm：如何生成 JSDoc 文档

Question

我刚刚开始使用 WebStorm 和 JSDoc 来记录我的 JavaScript。我仍然没有找到使用某种 WebStorm 内置功能生成 HTML 文档的方法。我搜遍了网络和Stack Overflow，但只发现了很多关于JSDoc语法等的问题

我错过了什么？我正在使用 WebStorm 7.0.3。

Answer 1

自 WebStorm v8.0.0 起，您只需在要添加文档的 /** 或

method

声明之前输入

function

，然后按

Enter

，即可创建 JSDoc 注释。这将生成一个基本块，其中所有

parameters

都已设置。

有关 此 WebStorm 文章的更多信息。

Answer 2

关于 jsDoc 的 phpStorm 的好文章，位于 此链接。

在 WebStorm 中我也这么认为。

Answer 3

WebStorm 没有内置的生成文档的功能。您可以使用外部解决方案，至少如 https://github.com/jsdoc3/jsdoc

我使用 jsduck：https://github.com/senchalabs/jsduck

Answer 4

WebStorm 有一个内置函数，可以在您的代码中创建 JSDoc 文档时提供一些帮助，他们在 this 文章中对此进行了解释。据我所知，WebStorm 插件商店中没有任何插件可以进一步帮助我们创建或呈现 JSDoc 文档。为此，您需要使用外部工具。