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

问题描述

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

Is it possible to generate a JSDoc documentation in IDEA / WebStorm with one click, just like I do JavaDoc with IntelliJ IDEA.

推荐答案

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

1. 将jsdoc安装到Node.js项目中:npm i jsdoc

1. Install jsdoc to the Node.js project: npm i jsdoc

准备一个JSDoc配置文件(jsdoc.json)并将其存储在项目的根目录中

Prepare a JSDoc configuration file (jsdoc.json) and store it in the root of the project

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

添加一个新的外部工具，该工具名为 Documentation 组的 Generate JSDoc….

Add a new external tool called Generate JSDoc… of group Documentation.

在工具设置中提供以下参数:

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

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

参数:JSDoc脚本和JSDoc配置(jsdoc.json)的路径，例如:$ProjectFileDir$/node_modules/jsdoc/jsdoc.js -c $ProjectFileDir$/jsdoc.json
在这里，可以使用IDE的内部命令$ProjectFileDir$

Arguments: path to JSDoc scripts and to the JSDoc config (jsdoc.json), e.g.: $ProjectFileDir$/node_modules/jsdoc/jsdoc.js -c $ProjectFileDir$/jsdoc.json
Here it is possible either specify absolute paths or provide a relative path using IDE's internal command $ProjectFileDir$

工作目录:来源的路径，例如:$ProjectFileDir$\src

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

按确定并应用

现在，转到工具→文档→生成JSDoc…等，然后根据JSDoc配置(jsdoc.json)生成并存储JSDoc.

Now, go to Tools → Documentation → Generate JSDoc…, et voilà, the JSDoc is generated and stored according to the JSDoc config (jsdoc.json).

P.S.本指南已在IntelliJ IDEA 2020.3上进行了测试.

P.S. This guide is tested on IntelliJ IDEA 2020.3.

这篇关于如何在IDEA/WebStorm中生成JSDoc文档?的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持！