JetBrains Rider 2026.3 Help

语言和框架:YAML

JetBrains Rider 使您能够使用 YAML 文件 ( .yml , .yaml ) 并支持以下功能:

  • 语法高亮显示

    您可以在 编辑器 | 配色方案 | YAML 对话框的 设置/首选项 页面(Ctrl+Alt+S )上更改 颜色设置。

  • 代码格式化

    您可以在 设置/首选项 对话框的 Ctrl+Alt+S 页面访问与 YAML 相关的代码样式设置(编辑器 | 代码样式 | YAML)。

  • 检查

    JetBrains Rider 能检测出 YAML 文档中的重复键、未使用的 锚点等。

  • 代码补全

    例如,您可以对包含 JSON schema 的 YAML 文档使用代码补全,或者完成锚点别名。

  • 导航与搜索

    例如,您可以在 锚点和别名之间导航。

  • 查找锚点用法

  • 重命名重构 (例如,对 anchors 和 aliases)

  • 输入处理程序

    JetBrains Rider 会在输入时维护缩进、序列标记、中括号和引用。

来了解一下编辑器中可用的一些 YAML 特定功能。

锚点和别名

JetBrains Rider 支持使用锚点和别名。 如果您在 YAML 文件中指定了一个新的 anchor,编辑器会显示一个警告,提示该 anchor 未被任何节点使用。

YAML:未使用的锚点警告

编辑器现在使您能够为此锚点 完成 别名。

YAML:完成别名

要快速查找锚点的用法,将文本光标放在锚点上并按下 Ctrl+B。

YAML:导航到别名

JetBrains Rider 支持 重命名重构锚点和别名:将文本光标放置在锚点上,然后按 Shift+F6。 或者,右键点击锚点并选择 重构(R) | 重命名。

重命名 YAML 锚点

使用 结构 工具窗口 (Alt+7) 快速浏览 YAML 文件。 要显示或隐藏 结构 工具窗口中重用锚点的元素,请点击 视图选项 使用 别名子树。

YAML 结构视图

JSON schemas

JetBrains Rider 支持使用 JSON schema 对 YAML 文件进行代码补全和检查。 JetBrains Rider 可以自动推断模式(基于文件位置或结构),或者您也可以 手动选择。 例如,如果您在 .github/workflows 目录中有 GitHub Actions workflow 文件,JetBrains Rider将基于从 schemastore.org自动加载的 github-workflow.json 模式建议其选项:

YAML:基于架构完成

您可以使用 语言与框架 | 架构和 DTD | 远程 JSON 架构 对话框的 设置/首选项 页面(Ctrl+Alt+S )管理加载 JSON 架构。

如果必要,您可以在 语言与框架 | 架构和 DTD | JSON 架构映射 中指定所需的架构文件路径。

为文件选择一个 JSON schema

您可以为特定文件指定自定义模式。

  1. 点击状态栏中的 schema 切换器。

    选择文件的架构
  2. 在打开的列表中,选择一个建议的模式或点击 新建架构映射…。 这将打开 JSON 架构映射 设置,您可以在其中为文件指定本地或远程架构。

从架构获取属性

如果 JetBrains Rider 检测到您的 YAML 文件的架构,您可以使用专门的操作快速将其所有属性插入到该文件中,从而无需手动输入。

  • 如果架构包含必需的属性,而您只想插入这些特定属性,请在文件中的任意位置按 Alt+Enter (显示上下文操作) 并选择 添加缺失的属性。

  • 如果您想插入模式中可用的所有属性,请在文件中的任意位置按 Alt+Enter (显示上下文操作 )并选择 填写 JSON 架构中的所有属性。

使用 $schema 关键字

您还可以直接在文件中引用架构。

  1. 在文件顶部,输入 # $schema:。

  2. 开始输入架构文件的名称。 将获得从 schemastore.org 加载的架构名称补全。

    如果您要使用本地 schema 文件,请指定相对于您要使用 schema 文件的位置的路径,例如, # $schema: ./my-schema.json。 这将启用与使用远程模式时相同的编码辅助,包括检查、补全和属性填充操作。

    从本地模式完成

复制密钥

JetBrains Rider 提供了复制 YAML 文件中指定选项的完整路径的功能。 您可以通过两种方式执行此操作:

  • 将文本光标放在所需的键上并按下 Ctrl+Alt+Shift+C。

  • 将鼠标悬停在所需的键上,右键点击并选择 复制引用(Y)。

YAML:复制引用

例如,在上面的图像中,将复制 default.server.port。

输入处理程序

编辑 YAML 文件时,JetBrains Rider 会维护缩进、序列标记、中括号和引用。 在以下示例中, <caret> 标记文本光标位置。

序列标记

在序列项后按 Enter 时,JetBrains Rider 会开始一个新项并自动插入 - 标记:

services: - nginx<caret>
services: - nginx - <caret>

如果在空项上再次按 Enter ,JetBrains Rider 会移除标记,并将文本光标移动到父级缩进级别,嵌套序列中也是如此。

当序列项包含映射时,按 Enter 会在新的缩进行继续映射,而不会添加第二个标记,即使已开启标记插入也是如此:

services: - name: web<caret> - name: db
services: - name: web <caret> - name: db

要删除空项,请在 - 标记后面的空格之后按 Backspace。 JetBrains Rider 会在一次操作中移除 - 及其后面的空格。 如果同一行中的标记后有值,JetBrains Rider 仍会将标记连同空格一起移除,并将值保留在原位:

services: - <caret>nginx
services: <caret>nginx

缩进

按 Enter 时,JetBrains Rider 会将新行保持在与当前结构匹配的缩进级别:

  • 在没有值的密钥之后,新行会加深一级缩进。

  • 在密钥-值对之后,新行会保持在同一级别。

  • 在块标量指示符 (|) 之后,新行会加深一级缩进,后续行会保持在该级别。

database:<caret>
database: <caret>

在块标量内部,新行会位于标准块缩进处,即密钥下一级。 如果当前行手动过度缩进,新行仍会使用标准块缩进,而不是与过度缩进的文本对齐。

如果在已完成条目下方仅包含空格的行上按 Enter ,JetBrains Rider 会保留手动设置的缩进,而不是重新对齐新行。

在尚无任何项的序列中的空行上键入 - 后接一个空格时,JetBrains Rider 会更正标记缩进。 开启 缩进序列值 选项时,标记会放在比父密钥深一级的位置;关闭该选项时,标记会与父密钥对齐。 如果序列已包含项,标记会保持当前缩进。 可以在 设置/首选项 对话框的 编辑器 | 代码样式 | YAML 页面上找到此选项 (Ctrl+Alt+S)。

中括号和引用

在密钥或值位置,JetBrains Rider 会自动闭合流集合和引用标量。 键入 [、 {、 " 或 ' 时,JetBrains Rider 会插入匹配字符,并将文本光标放在这对字符之间:

ports: <caret>
ports: [<caret>]

自动闭合仅适用于字符开始 YAML 结构标记的位置,例如新的密钥或值位置,或者现有流集合内部的某个点。 当文本光标位于纯标量文本内或紧随其后时,JetBrains Rider 会将该字符作为普通文本插入,而不会闭合任何内容。

当在相同字符之前键入闭合 ]、 } 或引用时,JetBrains Rider 会将文本光标移到其后,而不是插入重复字符。 但是,如果下一个字符是未配对的引用,键入相同的引用字符会创建新的一对,而不是跳过现有的引用。

要删除空字符对,请在两个字符之间按 Backspace ,JetBrains Rider 会将二者都移除。

移动密钥和项目

要移动密钥、嵌套块或序列项,请将文本光标放在其上并按 Ctrl+Shift+Up 或 Ctrl+Shift+Down。 JetBrains Rider 会移动整个条目,包括其嵌套内容,并保持缩进正确:

services: web<caret>: image: nginx db: image: postgres
services: db: image: postgres web<caret>: image: nginx

如果选择多个条目,JetBrains Rider 会将选择范围扩展为完整条目,并将它们作为一组移动。

粘贴

将内容粘贴到 YAML 文件中时,JetBrains Rider 会将其调整为目标结构:

  • 粘贴到序列中的纯文本行会变成单独的项,每项都有自己的 - 标记。

  • 如果粘贴的行以 - 开头,或者混合了带前缀和不带前缀的行,JetBrains Rider 会规范化标记,使每行恰好有一个标记。

  • 点分路径(例如 spring.datasource.url )会展开为嵌套密钥。

  • 多行块会重新缩进,使其第一行与文本光标缩进匹配,而内部行会保持其相对缩进。 空行保持为空。

  • 直接粘贴到现有密钥之前时,JetBrains Rider 会重新缩进粘贴的块,并将现有密钥保持在其原始列。

例如,在映射位置粘贴 spring.datasource.url:

config: <caret>
config: spring: datasource: url:<caret>

要开启或关闭点分密钥展开,请使用 设置/首选项 对话框的 编辑器 | 常规 | 智能键 | YAML 页面上的 粘贴时自动展开键序列 选项(Ctrl+Alt+S)。

2026年 11月 10日