如何在 IDEA / WebStorm 中生成 JSDoc 文档？

How to generate a JSDoc documentation in IDEA / WebStorm?

能不能像我用IntelliJ IDEA做JavaDoc一样，在IDEA/WebStorm中一键生成JSDoc文档

TL;DR:

将 JSDoc 文档生成功能添加到 IntelliJ IDEA / WebStorm:

  1. 安装jsdoc到Node.js项目：npm i jsdoc

  2. 准备一个JSDoc配置文件（jsdoc.json）并存放在项目根目录下

  3. 转到文件 |设置 |工具 | IntelliJ 中的外部工具 IDEA / WebStorm

  4. 添加名为 Generate JSDoc… 的新外部工具 Documentation.

  5. 在工具设置中提供以下参数：

    • 程序：Node.js二进制文件的路径，例如：C:\Program Files\nodejs\node.exe

    • Arguments：JSDoc 脚本和 JSDoc 配置的路径 (jsdoc.json)，例如：$ProjectFileDir$/node_modules/jsdoc/jsdoc.js -c $ProjectFileDir$/jsdoc.json
      这里可以指定绝对路径或使用 IDE 的内部命令 $ProjectFileDir$

      提供相对路径

    • 工作目录：源路径，例如：$ProjectFileDir$\src

  6. 按确定并应用

现在，转到 工具 → 文档 → 生成 JSDoc…，等等，JSDoc 是根据 JSDoc 配置（jsdoc.json）生成和存储的。

P.S。本指南已在 IntelliJ IDEA 2021.2.

上进行测试