WebStorm: как создать документацию JSDoc

Я только начал использовать WebStorm и JSDoc для документирования своего JavaScript. Тем не менее я не нашел способа создать документацию в формате HTML, используя какую-то встроенную функциональность WebStorm. Я искал в Интернете и Stack Overflow, но нашел только много вопросов о синтаксисе JSDoc и т. д.

Что мне не хватает? Я использую WebStorm 7.0.3.


person java-pe    schedule 06.02.2014    source источник


Ответы (4)


Хорошая статья о jsDoc для phpStorm на эта ссылка.

В WebStorm я думаю то же самое.

person Wiki    schedule 24.06.2014

Начиная с Webstorm v8.0.0, вы можете создавать комментарии JSDoc, просто набрав /** прямо перед объявлением method или function, которое вы хотите добавить в документацию, а затем нажмите Enter , это создаст базовый блок со всеми вашими уже установленными parameters.

Подробнее читайте в этой статье Webstorm.

person Balthazar    schedule 10.10.2014
comment
Почему этот ответ получил наибольшее количество голосов, если он относится только к тому, как написать исходный код jsdoc, а не визуализировать документацию из jsdoc, о чем и идет речь? - person JHH; 13.11.2018

WebStorm не имеет встроенных функций для создания документации. Для этого вы можете использовать внешние решения, по крайней мере, как https://github.com/jsdoc3/jsdoc

Я использую для этого jsduck: https://github.com/senchalabs/jsduck

person Vlad    schedule 07.02.2014

WebStorm имеет встроенную функцию, которая немного помогает при создании документации JSDoc в вашем коде, они объясняют это в этой статье. Насколько я мог искать, в магазине плагинов WebStorm нет плагина, который помог бы нам создавать или отображать документацию JSDoc. Для этого вам нужно будет использовать внешние инструменты.

person Alberto Perez    schedule 01.08.2019