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

Question

是否可以一键在IDEA/WebStorm中生成JSDoc文档，就像我用IntelliJ IDEA做JavaDoc一样。

Answer 1

TL;DR:

向 IntelliJ IDEA / WebStorm 添加 JSDoc 文档生成功能：

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

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

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

6. 按确定和应用

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

附：本指南在 IntelliJ IDEA 2021.2 上进行了测试。