IntelliJ IDEA 中的 JSDoc 支持答案

【问题标题】：JSDoc support in IntelliJ IDEAIntelliJ IDEA 中的 JSDoc 支持
【发布时间】：2020-09-30 16:41:54
【问题描述】：

是否有关于 JSDoc 子集、超集或两种 IntelliJ 支持的混合的文档？我使用 JSDoc 的动机有两个：

对于开发人员：因此 IntelliJ 可以提供更好的代码完成、代码检查、错误检查等。
为了提高运行时效率：使用Closure compiler。

对于上面的 #1，使用 IntelliJ 支持的 JSDoc 标记对我来说很重要，直到现在解决这个问题主要是一个反复试验的过程。

【问题讨论】：

【解决方案1】：

根据WebStorm documentation 中提供的少量信息，IntelliJ IDEA 似乎支持整个 JSDoc 集。文档中唯一的其他注释是在 viewing inline documentation 上，它只指向 JSDoc SourceForge page。

【讨论】：

【解决方案2】：

这有点反复试验，但我终于能够得到不错的结果。我在获取 Backbone 类似 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 等）。

【讨论】：

【解决方案3】：

IDEA / WebStorm 对 JSDoc 的支持是当今的标准功能，但通过一些 IDE 调整，可以一键生成 JSDoc。

如何使用jsdoc npm 模块在 IDEA / WebStorm 中启用 JSDoc 生成的分步指南： How to generate JSDoc documentation in IntelliJ IDEA / WebStorm?

【讨论】：