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


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

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

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

2 13

2 ответа:

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

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

/**
 * @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, иначе он запутывается. @name, кажется, не очень хорошо работает. Остальной вполне прилично, некоторые теги не используются (@event и т. д...).