程序员经验分享-hwhale

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

2023-12-01

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


TL;DR:

enter image description here

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

  1. Install jsdoc到 Node.js 项目：npm i jsdoc

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

  3. Go to 文件 |设置|工具|外部工具在 IntelliJ IDEA / WebStorm 中

  4. 添加一个名为的新外部工具生成 JSDoc...组的文档.

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

    • 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. Press OK and Apply

现在，前往工具 → 文档 → 生成 JSDoc...等等，JSDoc 是根据 JSDoc 配置生成并存储的（jsdoc.json).

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

本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)

intellijidea

webstorm

jsdoc

如何在IDEA/WebStorm中生成JSDoc文档？ 的相关文章

随机推荐

  • asio隐式链和数据同步

    当我阅读asio源代码时 我很好奇asio是如何在线程之间同步数据的 甚至是隐式链的制作 这些是 asio 中的代码 io service 运行 mutex scoped lock lock mutex std size t n 0 for

  • Swift 函数调用列表参数类型不正确

    我定义了下面的 swift 类 并尝试从视图控制器调用 sfAuthenticateUser 但是 Xcode 智能感知列出了除我定义的类型之外的错误参数类型 错误 无法将类型 String 的值转换为预期参数类型 APISFAuthent

  • 内联 Javascript（在 HTML 中）如何工作？

    我知道这是不好的做法 如果可能的话 不要编写这样的代码 当然 我们总是会发现自己处于这样的情况 巧妙的内联 Javascript 片段可以快速解决问题 我正在追求这个查询 以便充分理解编写这样的内容时会发生什么 以及潜在的陷阱 a href

  • 将全局设置应用于 pyplot 中的所有子图

    这与this and this问题 我有一系列具有非常相似设置的图形和子图 但是 我似乎无法找到同时设置它们的方法 这是一个简化版本 我通常使用更多实例 fspec plt figure 1 spC fspec add subplot 21

  • “AMOUNT1”在使用它的上下文中无效

    我在 DB2 中执行以下查询 select SUM orders totalproduct orders TOTALTAX orders totalshipping orders totaladjustment as amount1 fro

  • jquery - 所需的表单验证规则取决于

    有人可以给我介绍一下如何使用validate rules required depends 我有一些部分代码 但不确定它是如何工作的 form2 validate rules firstname required depends funct

  • ASP.NET MVC 应用程序变量？

    ASP NET 中有应用程序变量吗 我想为所有用户存储一个对象 该对象应该每 5 分钟独立更新一次 但所有用户都应该始终看到它的最新版本 有什么建议 C 吗 您可以在 ASP NET 中存储应用程序范围的数据Cache 使用以下命令将您的项

  • 用于两行和多列的 Xml 到表转换的 XSL

    我一直在尝试解决上周提出的问题的变体 用于 Xml 到表转换的 XSL 我必须将每个部分的第一个和最后一个页码输出到一个有两行的表中 我对如何将两行表与 Muenchian 分组方法集成感到困惑 XSLT 1 0 解决方案正是我所需要的 我

  • 在调查与 GPO 部署相关的错误时，如何获取 Windows Installer 的更详细/详细日志？

    我正在学习如何通过 GPO 方法从 Windows 2012 Server 将 MSI 应用程序部署到 Windows 10 客户端 在 Windows Server 中 我使用以下设置创建了一个新的 GPO 包 但是 它在Windows

  • Math.cos、sin 和 tan 在 Java 中返回不准确的值

    我正在用 Java 开发一个带有 GUI 的计算器 项目已完成 但三角函数无法正常工作 这是 cos 函数的方法 public void actionPerformed ActionEvent evt input Double valueO

  • 将变量列表单独传递给 clojure 函数

    我一直在使用 clojure 并决定创建一个结合了 mapcat 和 list 的高阶函数来模拟这种行为 Clojure gt mapcat list 1 2 3 4 5 6 7 8 1 5 2 6 3 7 4 8 我的第一次尝试是定义 m

  • jQuery 插件 .fn 问题

    我在创建 jquery 插件时似乎遇到了一些问题 我正在 firebug 控制台中测试一个简单的插件 但该功能并未按我的预期定义 这是我正在使用的代码模式 jQuery fn test function console log runs 我

  • 将地点 ID 位置传递到 Google 地图 API 中的目的地

    我试图弄清楚如何将 Google Places 位置的几何位置动态传递到路线服务请求目的地 如果我使用 service getDetails placeId ChIJy YmBMEMIocRZF8r5wPFMYU function plac

  • 如何在flume中同时使用regex_extractor选择器和多路复用拦截器？

    我正在测试 Flume 将数据加载到 hHase 中 并考虑使用 Flume 的选择器和拦截器进行并行数据加载 因为源和接收器之间的速度差距 所以 我想要用 Flume 做的是 使用拦截器 regexp extract 类型创建事件标头 使

  • 在 Angular 5 中重用 html 内容

    在开始这个问题之前 我先澄清一下我是新人 所以请耐心等待 我会尽力解释自己 在引导程序中 我可以通过以下方式生成模态 modal component html div class modal fade div class modal dia

  • 使用 Jackson 将 JPA 实体序列化为 JSON

    关于 Jackson JPA 组合的问题 如果当前应用程序中有大约 20 个实体 并且我在 POM 中添加了 Jackson 依赖项 这是否意味着默认情况下所有实体都准备好转换为JSON目的 我看到一个示例项目似乎只有类注释为 JsonIg

  • CSS 媒体查询打印纸张尺寸

    世界各地的纸形状都不一样 我有一份文档 希望以 A4 纸和 US Letter 纸进行不同的打印 某些元素应该隐藏或显示 明显的建议是使用媒体查询 如下所示 media print and max height 280mm a4 only

  • windows机器上python的无缓冲字符输入

    我正在尝试做什么 我正在尝试设计一个具有单圈计时功能的秒表 当您按 L 时 一圈将完成 当您按 S 时 所有圈将完成 并按顺序显示计时 在 C 中 我可以使用 conio h 中的函数 getch 来完成此操作 这将非常容易 我想用 pyt

  • 显示App_Data中存储的图像

    我的 App Data 目录中有 2 个图像文件 我想在我的视图中显示它们 如下所示 foreach var media in Model div class col lg 3 col md 4 col xs 6 thumb a class

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

    是否可以在IDEA WebStorm中一键生成JSDoc文档 就像我用IntelliJ IDEA做JavaDoc一样 TL DR 要将 JSDoc 文档生成功能添加到 IntelliJ IDEA WebStorm Install jsdoc

热门标签