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

Question

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

Answer 1

特尔；博士：

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

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

2. 准备一个JSDoc配置文件( jsdoc.json)，存放在项目根目录下

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

4. 添加一个名为Generate JSDoc... of group Documentation的新外部工具。

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

   • Program：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)生成和存储的。

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