WebStorm:如何生成JSDoc文档

时间:2014-02-06 22:58:31

标签: javascript webstorm jsdoc

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

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

4 个答案:

答案 0 :(得分:19)

Webstorm v8.0.0开始,您只需在/**method之前输入function即可创建 JSDoc 评论声明您要添加文档,然后按 Enter ,这将生成一个已设置所有parameters的基本块。

有关this Webstorm article的更多信息。

答案 1 :(得分:4)

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

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

答案 2 :(得分:4)

this link上关于 phpStorm jsDoc 的好文章。

在WebStorm中我猜是一样的。

答案 3 :(得分:0)

WebStorm具有内置功能,可以在您的代码中创建JSDoc文档时提供一些帮助,他们在this文章中对此进行了解释。就我所寻找的而言,WebStorm插件存储上没有插件可以进一步帮助我们创建或呈现JSDoc文档。为此,您需要使用外部工具。