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

迈克 B。

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

迈克 B。

将 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 2020.3 上进行了测试。

本文收集自互联网,转载请注明来源。

如有侵权,请联系[email protected] 删除。

编辑于
0

我来说两句

0条评论
登录后参与评论

相关文章

来自分类Dev

WebStorm:如何生成JSDoc文档

来自分类Dev

如何在Haddock文档中生成表

来自分类Dev

如何在CUDA C ++中生成XML文档文件?

来自分类Dev

JSDoc生成的文档中的功能分组

来自分类Dev

当JSDoc是包含对象的数组时,如何在JSDoc中实现文档变量?

来自分类Dev

如何通过Javascript在RTF中生成文档

来自分类PHP

如何在Laravel 5.8 API中生成GET请求Swagger API文档?

来自分类Dev

如何在ASP.NET 5中生成XML文档文件

来自分类Dev

如何为JSDoc生成HTML

来自分类Dev

在R中生成XML文档

来自分类Dev

在宏中生成文档

来自分类Dev

JSDoc继承参数文档

来自分类Dev

JSDoc的jQuery插件文档

来自分类Dev

JSDoc 文档最终方法

来自分类Dev

JSDoc - 类型的文档对象

来自分类Java

如何使用XSLT和Apache FOP在PDF文档中生成条形图

来自分类Dev

如何从Swashbuckle的XML文档中生成有关枚举的描述?

来自分类Dev

如何使用cakephp在单个文档中生成多个Excel工作表

来自分类Dev

JSDoc中的文档重载函数

来自分类Dev

自动模块以在sphinx文档中生成toc

来自分类Dev

在Codeigniter项目中生成REST文档

来自分类Dev

如何在JS或React中生成UUID?

来自分类Dev

如何在 Excel 中生成 S 曲线?

来自分类Dev

如何在R中生成点?

来自分类Dev

如何在Liquibase中生成GRANT?

来自分类Dev

如何在熊猫中生成动态列

来自分类Java

如何在Java中生成SOAP存根?

来自分类Dev

如何在列表中生成圆的坐标

来自分类Dev

如何在Android中生成小apk