{"id":246,"date":"2010-07-27T13:34:03","date_gmt":"2010-07-27T11:34:03","guid":{"rendered":"http:\/\/www.speich.net\/articles\/?p=246"},"modified":"2019-10-06T12:33:50","modified_gmt":"2019-10-06T10:33:50","slug":"how-to-create-javascript-documentation-in-phpstorm","status":"publish","type":"post","link":"https:\/\/www.speich.net\/articles\/en\/2010\/07\/27\/how-to-create-javascript-documentation-in-phpstorm\/","title":{"rendered":"How to create JavaScript documentation in PhpStorm"},"content":{"rendered":"

Update 19.07.2013<\/strong>: This guide is outdated. Read How to Generate JavaScript Documentation with JSDoc 3 and PhpStorm<\/a><\/p>\n

PhpStorm’s<\/a> code assist feature nicely displays our own JavaScript code documentation. But what if you wanted to create a separate documentation you can hand out or integrate into your website? Then you should use jsdoc-toolkit<\/a>. You can configure and run jsdoc-toolkit directly from PhpStorm. Here is what you have to do:<\/p>\n

<\/p>\n

File -> Settings -> External Tools ->Add…<\/p>\n

\"Install
Screenshot of how to install jsdoc-toolkit as an external tool in PhpStorm.<\/figcaption><\/figure>\n

Provide the following information:<\/p>\n

Name<\/strong>:\u00a0 jsdoc-toolkit
\nThis name will show up in your Tools Menu. If you fill in a group name such as JavaScript, then the entry will become a submenu of JavaScript.<\/p>\n

Program<\/strong>: <pathToJava.exe>
\nFill in the path to your java executable, e.g. C:Program FilesJavajdk1.6.0_19binjava.exe<\/p>\n

Parameters<\/strong>: -jar jsrun.jar apprun.js -t=templatescodeview -v -r “<pathToSourceDirectory>” -d=”<pathToDestinationDirectory>”
\nThe source directory is the one you want to document, e.g. where your JavaScript files reside in. The destination directory is where you want the documentation to be created in. Please note, that paths are given without a trailing slash. In case your path arguments contain spaces it is important to enclose these parameter in quotes<\/strong>.\u00a0 For more information about the parameters see the jsdoc-toolkit wiki<\/a>.<\/p>\n

Working Directory<\/strong>: <pathToJsdocToolkit>
\nFill in the path to your jsdoc-toolkit installation directory, e.g. C:Website Toolsjsdoc-toolkit<\/p>\n

\"Screenshot
Screenshot of how to install jsdoc-toolkit into PhpDocumentor.<\/figcaption><\/figure>\n

In case you also wanted to create documentation for your PHP code, you should read the blog entry ‘How to create PHP documentation in PhpStorm<\/a>‘.<\/p>\n","protected":false},"excerpt":{"rendered":"

Update 19.07.2013: This guide is outdated. Read How to Generate JavaScript Documentation with JSDoc 3 and PhpStorm PhpStorm’s code assist feature nicely displays our own JavaScript code documentation. But what if you wanted to create a separate documentation you can hand out or integrate into your website? Then you should use jsdoc-toolkit. You can configure … <\/p>\n

Continue reading “How to create JavaScript documentation in PhpStorm”<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[3],"tags":[49,75,91],"class_list":["post-246","post","type-post","status-publish","format-standard","hentry","category-javascript","tag-jsdoc-toolkit","tag-phpstorm","tag-tutorial","entry"],"_links":{"self":[{"href":"https:\/\/www.speich.net\/articles\/wp-json\/wp\/v2\/posts\/246","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.speich.net\/articles\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.speich.net\/articles\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.speich.net\/articles\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.speich.net\/articles\/wp-json\/wp\/v2\/comments?post=246"}],"version-history":[{"count":1,"href":"https:\/\/www.speich.net\/articles\/wp-json\/wp\/v2\/posts\/246\/revisions"}],"predecessor-version":[{"id":1692,"href":"https:\/\/www.speich.net\/articles\/wp-json\/wp\/v2\/posts\/246\/revisions\/1692"}],"wp:attachment":[{"href":"https:\/\/www.speich.net\/articles\/wp-json\/wp\/v2\/media?parent=246"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.speich.net\/articles\/wp-json\/wp\/v2\/categories?post=246"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.speich.net\/articles\/wp-json\/wp\/v2\/tags?post=246"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}