如何解决如何在IDEA / WebStorm中生成JSDoc文档?
是否可以一键生成IDEA / WebStorm中的JSDoc文档,就像我使用IntelliJ IDEA生成JavaDoc一样。
解决方法
要将JSDoc文档生成的功能添加到IntelliJ IDEA / WebStorm:
-
将
jsdoc
安装到Node.js项目:npm i jsdoc
-
准备一个JSDoc配置文件(
jsdoc.json
)并将其存储在项目的根目录中 -
转到文件|设置|工具| IntelliJ IDEA / WebStorm中的外部工具
-
添加一个新的外部工具,该工具名为 Documentation 组的 Generate JSDoc…。
-
在工具设置中提供以下参数:
-
程序: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.json
)生成并存储JSDoc。
TL; DR:
P.S。本指南已在IntelliJ IDEA 2020.3上进行了测试。
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。