Ищу: Пример использования jsDoc с Webstorm IDE (v 4)

Я все еще изучаю js и пробую IDE Webstorm, которая кажется приятной (включая переход к объявлениям var/function).

Я вижу, как получить шаблон для комментария jsdoc, но у меня нет опыта работы с ним, и я ищу пример того, как предоставить более подробную информацию в комментарии и как просмотреть эту информацию.


person Clay Nichols    schedule 18.06.2012    source источник


Ответы (3)


WebStorm 4.0 поддерживает большинство тегов JSDoc. Например, когда вы указываете @type для переменной, завершение будет работать лучше, а присвоение выражений неправильным типам будет выделено как предупреждение. Всплывающее окно документации элемента появляется при нажатии Ctrl+Q на какой-либо ссылке. Более подробную информацию о поддерживаемых тегах можно найти в системе отслеживания задач JetBrains, например, issue WI-1295.

Кроме того, в 5-й версии ожидается лучшая поддержка тегов компилятора замыкания Google.

person de1mar    schedule 20.06.2012


Я чувствую вашу боль... Недавно я также начал оценивать WebStorm и обнаружил, что объем документации о том, как интегрировать JSDoc в ваш код, немного недостаточен.

На следующей странице представлено много подробностей о доступных тегах, а также подробное описание каждого тега.

http://code.google.com/p/jsdoc-toolkit/wiki/TagReference

Надеюсь, это поможет!

person jeremyalan    schedule 01.07.2012