有没有可能像我用IntelliJ IDEA做JavaDoc一样,在IDEA/WebStorm中一键生成JSDoc文档
最佳答案
长话短说:
为 IntelliJ IDEA/WebStorm 添加 JSDoc 文档生成功能:
安装
jsdoc
到Node.js项目:npm i jsdoc
准备一个JSDoc配置文件(
jsdoc.json
),存放在项目根目录下转到文件 |设置 |工具 | IntelliJ IDEA/WebStorm 中的外部工具
在 Documentation 组中添加名为 Generate JSDoc... 的新外部工具。
在工具设置中提供以下参数:
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
按确定并应用
现在,转到工具 → 文档 → 生成 JSDoc...,等等,JSDoc 已根据 JSDoc 配置(jsdoc.json
)生成并存储。
附言本指南已在 IntelliJ IDEA 2021.2 上进行测试。
关于intellij-idea - 如何在 IDEA/WebStorm 中生成 JSDoc 文档?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/64069426/