CODEWITHSUNDEEP
javascriptwebstormjsdoc
Tobias
Tobias

Reputation: 203

WebStorm: How to generate JSDoc documentation

I just started using WebStorm and JSDoc to document my JavaScript. Still I have not found a way to generate a HTML documentation using some kind of WebStorm built-in functionality. I searched the web and Stack Overflow, but only found a lot of questions about the syntax of JSDoc, etc.

What am I missing? I am using WebStorm 7.0.3.

Upvotes: 20

Views: 27890

Answers (4)

Preview
Preview

Reputation: 35846

Since WebStorm v8.0.0, you can create JSDoc comments by simply typing /** right before the method or function declaration you want to add the documentation, and then press Enter. This will generate a basic block with all your parameters already set.

More info on this WebStorm article.

Upvotes: 45

Alberto Perez
Alberto Perez

Reputation: 2922

WebStorm has a built-in function to help a little when creating JSDoc documentation in your code, they explain it in this article. As far as I could look for, there's no plugin on the WebStorm plugin store to further help us creating nor rendering JSDoc documentation. For that, you would need to use external tools.

Upvotes: 0

Wiki
Wiki

Reputation: 351

Nice article about jsDoc for phpStorm at this link.

In WebStorm I guess the same.

Upvotes: 5

Vlad
Vlad

Reputation: 3645

WebStorm has no built-in functionality to generate documentation. You can use external solutions for that, at least as https://github.com/jsdoc3/jsdoc

I use jsduck for that: https://github.com/senchalabs/jsduck

Upvotes: 2

Related Questions