16

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

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

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

4

3 回答 3

9

根据WebStorm 文档中提供的少量信息，IntelliJ IDEA 似乎支持整个 JSDoc 集。文档中唯一的其他说明是查看仅指向JSDoc SourceForge 页面的内联文档。

于 2011-02-13T03:41:09.253 回答
7

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

于 2012-01-14T13:18:34.387 回答
0

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

分步指南如何使用jsdocnpm 模块在 IDEA / WebStorm 中启用 JSDoc 生成： 如何在 IntelliJ IDEA / WebStorm 中生成 JSDoc 文档？

于 2020-09-26T12:37:12.823 回答