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

Question

在IDEA / WebStorm中只需一次单击就可以生成一个JavaDoc文档，就像我用IntelliJ IDEA做JavaDoc一样。

Answer 1

TL;DR：

​

​

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

将npm i jsdoc安装到Node.js项目的

1. jsdoc

1. 准备一个JSDoc配置文件(jsdoc.json)，并将其存储在项目

的根目录中。

1. 转到IntelliJ IDEA / WebStorm

中的文件集设置

1. 添加了一个名为生成JSDoc…的新外部工具。Documentation.

群的

1. In 工具设置提供以下参数：

- **Program**: path to the Node.js binary, e.g.: `C:\Program Files\nodejs\node.exe`

在这里，可以指定绝对路径或使用

- **Arguments**: path to JSDoc scripts and to the JSDoc config (`jsdoc.json`), e.g.: `$ProjectFileDir$/node_modules/jsdoc/jsdoc.js -c $ProjectFileDir$/jsdoc.json`

的内部命令$ProjectFileDir$提供相对路径

- **Working directory**: path to the sources, e.g.: `$ProjectFileDir$\src`

Apply

1. Press OK和

现在，转到Tools→文档→生成JSDoc…。，et voilà，根据JSDoc配置(jsdoc.json)生成和存储JSDoc。

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