我刚开始使用WebStorm和JSDoc来记录我的JavaScript代码的文档。但是，我还没有找到一种使用WebStorm内置功能生成HTML文档的方法。我在网上和Stack Overflow上搜索过，但只找到很多关于JSDoc语法等的问题。
我错过了什么？我正在使用WebStorm 7.0.3。
4个回答
44
自从WebStorm v8.0.0版本以来，您可以通过在您想要添加文档的方法或函数声明之前简单地键入`/**`，然后按下`Enter`键来创建JSDoc注释。这将生成一个基本块，并已设置好所有参数。
有关更多信息，请参阅这篇WebStorm文章。
有关更多信息，请参阅这篇WebStorm文章。
- Preview
2
2为什么这个回答是最受赞的，当它只适用于如何编写jsdoc源代码 - 而不是从jsdoc渲染文档，这才是问题所在的地方？ - JHH
1@JHH，因为这是回答实际遇到此问题的人的问题。我谷歌搜索了“如何使用JSDOC和WebStorm自动记录JS代码”，然后就来到了这里。标题有些误导，因为原帖作者想要制作一个显示文档的页面。实际上文档是由JSDOC生成的... - bcstryker
5
在这个链接上有一篇关于在phpStorm中使用jsDoc的好文章。
我猜在WebStorm中也是同样的方法。
- Wiki
2
5新链接 http://www.speich.net/articles/generate-javascript-documentation-with-jsdoc-3-and-phpstorm/本文介绍如何使用JSDoc 3和PhpStorm生成JavaScript文档。 - Wiki
1更新的文章：https://www.speich.net/articles/en/2016/04/10/use-jsdoc-3-and-phpstorm-to-generate-javascript-documentation/ - Alberto Perez
2
WebStorm没有内置生成文档的功能。您可以使用外部解决方案，例如https://github.com/jsdoc3/jsdoc。
我使用jsduck进行文档生成：https://github.com/senchalabs/jsduck。
我使用jsduck进行文档生成：https://github.com/senchalabs/jsduck。
- Vlad
0
WebStorm内置了一个功能，可以在您的代码中创建JSDoc文档时提供一些帮助，他们在this文章中解释了这个功能。就我所知，在WebStorm插件商店中没有插件可以进一步帮助我们创建或呈现JSDoc文档。为此，您需要使用外部工具。
- Alberto Perez
网页内容由stack overflow 提供, 点击上面的可以查看英文原文，
原文链接
原文链接