RubyMine 2025.2 Help

JSDoc 注释

RubyMine 识别 JSDoc 注释 并通过在输入块注释开头 /** 并按下 Enter 时自动插入 @param, @returns, @private 以及其他标签来帮助您创建它们。 JSDoc 注释用于在 JavaScript 和 TypeScript 中通过 Ctrl+Q 进行文档查找,请参见 JavaScript 文档查找TypeScript 文档查找 ,以及在链式方法中用于 类型注解方法返回类型提示

RubyMine 还识别文档注释中的 TODO 模式Closure Compiler 注解和 TypeScript 语法 ,并在代码补全、意图操作及其他类型的编码辅助中使用它们。

JSDoc 入门JSDoc 支持的类型 中查找包含示例的 JSDoc 语法详细说明。

创建 JSDoc 注释

  • 将文本光标放在要记录的方法/函数或字段的声明前,键入起始块注释 /** ,然后按 Enter

    RubyMine 生成一个带有参数列表(@param )和返回值(@returns )的 JSDoc 注释,如果适用。 描述所列参数、返回值等。

    生成 jsdoc 注释
  • 或者,使用专用的 修复文档注释 操作。 将文本光标置于要记录的方法/函数或字段处,按 Ctrl+Shift+A 并开始键入 修复文档注释。 然后从列表中选择 修复文档注释 ,并按 Enter

JSDoc 注释中的 TypeScript 语法

您可以在 JavaScript 文件中的 JSDoc 注释内使用 TypeScript 注解,例如, @type@typedef。 RubyMine 识别 TypeScript 语法结构,例如 联合类型@typedef 声明中的可选属性。

RubyMine 为 TypeScript 注解提供代码补全。

在 JavaScript 文件中为 JSDoc 中的 TypeScript 注释提供代码完成功能

根据 @type 注解,RubyMine显示参数提示。

参数提示基于 JavaScript 文件中 JSDoc 内的类型注解显示

在编辑器中查看 JSDoc 注释展示效果

通过 RubyMine,JSDoc 注释可以以更易读的格式显示。 在此 呈现视图模式中,项目按其 @ 标签进行分组显示,而标签本身则被跳过。 您可以打开引用的网页、查看引用主题的快速文档,并调整字号以提高可读性。

为 JSDoc 注释渲染视图
  • 进入 渲染视图模式,请将鼠标悬停在评论上并点击 切换渲染视图图标 或按下 Ctrl+Alt+Q。 图标变成 切换渲染视图图标

    打开渲染视图模式
  • 退出 渲染视图模式,点击 切换渲染视图图标 ,或者从 JSDoc 注释的上下文菜单中选择 切换渲染视图 ,或按 Ctrl+Alt+Q

    关闭 Rendered View 模式
  • 要在当前文件中为所有 JSDoc 注释开启 Rendered View 模式,请从边栏的上下文菜单中选择 呈现所有文档注释

    将所有注释渲染到当前文件中
  • 如有必要,请从上下文菜单中选择 调整字体大小 ,并使用滑块更改字体大小。

    调整字体大小
  • 要默认显示所有渲染的 JSDoc 注释,请打开 设置 对话框(Ctrl+Alt+S ),转到 编辑器 | 常规 | 外观 ,并选中 渲染文档注释 复选框。

    默认启用渲染的 JSDoc 注释
  • 要隐藏 Rendered View 槽图标,请从槽的上下文菜单中选择 配置装订区域图标… ,然后在打开的 设置 | 编辑器 | 常规 | 栏标图标 页面上取消选择 文档注释就地渲染 复选框。

最后修改日期: 2025年 9月 26日