javascript WebStorm:如何生成JSDoc文档

643ylb08  于 2023-09-29  发布在  Java
关注(0)|答案(4)|浏览(160)

我刚开始使用WebStorm和JSDoc来记录我的JavaScript。我仍然没有找到一种方法来生成一个HTML文档使用某种WebStorm内置功能。我搜索了网页和Stack Overflow,但只发现了很多关于JSDoc语法的问题,等等。
我错过了什么?我使用的是WebStorm 7.0.3。

pod7payv

pod7payv1#

WebStorm v8.0.0开始,您只需在要添加文档的methodfunction声明之前键入/**,然后按Enter即可创建 JSDoc 注解。这将生成一个基本块,其中已经设置了所有parameters
关于this WebStorm article的更多信息

gj3fmq9x

gj3fmq9x2#

this link上关于 jsDoc for phpStorm 的好文章。
在WebStorm中,我猜也是一样。

ou6hu8tu

ou6hu8tu3#

WebStorm没有生成文档的内置功能。您可以为此使用外部解决方案,至少可以使用https://github.com/jsdoc3/jsdoc
我使用jsduck来实现:https://github.com/senchalabs/jsduck

dkqlctbz

dkqlctbz4#

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

相关问题