Поддержка JSDoc в IntelliJ IDEA - PullRequest
       25

Поддержка JSDoc в IntelliJ IDEA

13 голосов
/ 04 ноября 2010

Есть ли документация для какого JSDoc подмножества, надмножества или смеси двух IntelliJ поддерживает? Моя мотивация для использования JSDoc двойная:

  1. Для разработчиков: IntelliJ может обеспечить лучшее завершение кода, проверку кода, проверку ошибок и т. Д.
  2. Для повышения эффективности во время выполнения: с помощью компилятора Closure .

Для # 1 выше, для меня важно использовать разметку JSDoc, поддерживаемую IntelliJ, и до сих пор выяснение этого было в основном методом проб и ошибок.

Ответы [ 2 ]

8 голосов
/ 13 февраля 2011

Судя по тому, что в документации WebStorm мало информации, похоже, что IntelliJ IDEA поддерживает весь набор JSDoc. Единственное другое примечание в документации касается просмотра встроенной документации , которая указывает только на страницу JSDoc SourceForge .

6 голосов
/ 14 января 2012

Это было немного методом проб и ошибок, но я наконец смог получить приличные результаты с ним. У меня были особые проблемы с получением наследства для ОО, аналогичного Backbone, для правильной работы. То, что я закончил, было такими вещами:

/**
 * @class App.Views.ProductView
 * @extends App.Views.TemplateView
 **/
App.Views.ProductView = App.Views.TemplateView.extend(
  /** @lends App.Views.ProductView **/
  {  
      /**
       * @param {string} str
       * @return string[]
       **/
      method: function (str) {
           return [str, str];
     }
  };

Вам определенно придется много помогать вручную, когда речь идет о наследовании.

Насколько я могу судить, расхождения были: у вас есть , чтобы предоставить имя @class, иначе это запутается. @ имя, кажется, не очень хорошо работает. Остальное прилично, некоторые теги не используются (@event и т. Д.).

...