JetBrains Rider 2025.1 Help

代码语法样式：隐式/显式类型（'var' 关键字）

使用 隐式类型的局部变量 （也称为 var 关键字），自 C# 3.0 引入以来，因其在许多场景中提高了可读性而变得非常流行。 默认情况下，JetBrains Rider 也鼓励使用 var 关键字，但其使用偏好是 灵活可配置的——例如，您可以选择在特定情况下或所有情况下使用显式类型，JetBrains Rider 将帮助您强制执行您的偏好。

从 C# 7.0 开始，您可以在 解构元组时声明局部变量。 如果您更喜欢在此类声明中使用 var ，您还可以配置样式以使用合并或分离的表示法，例如： var (x, y) = GetTuple(); 或 (var x, var y) = GetTuple();。

另一个 C# 7.0 功能是 丢弃 ，它还允许使用 var 以确保范围内没有与可能命名为 _ 的变量冲突。 JetBrains Rider 允许您配置样式以在适当的情况下始终与丢弃一起使用 var。

强制执行使用 'var' 关键字的偏好设置

JetBrains Rider 检查所有局部变量是否符合您的 偏好设置 ，如果不符合，JetBrains Rider 会 高亮显示此类声明，并建议相应的 快速修复或 范围修复。

默认情况下，JetBrains Rider 的偏好设置表明更倾向于使用 'var' 关键字：

'var' 使用快速修复

如果您更改了偏好设置，JetBrains Rider 将帮助您使用显式类型：

'var' 使用快速修复

另一种以批量模式强制执行 'var' 关键字使用偏好设置的选项是 代码清理。 您可以使用内置的配置文件之一 运行代码清理 ，例如 完全清理或 重新格式化并应用语法样式 ，或者创建并运行 仅针对特定任务的自定义配置文件 ，如下所述。

使用自定义代码清理配置文件应用 'var' 关键字的偏好设置

  1. 按下 Ctrl+Alt+S 或从菜单中选择 文件 | 设置 （Windows 和 Linux）或 JetBrains Rider | 首选项 （macOS）。

  2. 转到代码清理配置文件设置页面： 编辑器 | 代码清理。

  3. 按照 创建新的自定义清理配置文件 部分中描述的步骤创建一个新配置文件。 在新配置文件的 选定的配置文件设置 部分中，勾选 强制使用 'var' 关键字的设置 复选框。 您还可以选择在此配置文件中启用其他代码清理任务。

  4. 在 设置 对话框中单击 保存 以应用修改，并让 JetBrains Rider 选择保存位置，或者通过从 保存 选择器中选择特定的设置层来保存修改。 如需了解更多信息，请参见 基于层的设置。

  5. 选择您希望强制执行偏好的范围：

    • 将光标放置在文件中的任意位置，以对文件强制执行您的偏好设置。

    • 在 解决方案资源管理器 中选择一个或多个项目，以对这些节点及其子项下的文件强制执行您的偏好设置。

  6. 按 Ctrl+R, C 或从主菜单中选择 代码 | 格式化和清理…。

  7. 在打开的 重新格式化并清理代码 对话框中，选择新创建的配置文件，并根据需要选择另一个范围。 .

  8. 点击 确定。 JetBrains Rider 将在选定范围内强制执行您的偏好设置。

如果您希望在不打开 重新格式化并清理代码 对话框选择配置文件的情况下强制执行 'var' 关键字使用偏好设置，可以将创建的配置文件绑定到 静默清理 ，并通过按 Ctrl+R, G 运行它。 您还可以创建一个 自定义清理配置文件 ，将应用偏好设置与其他代码样式任务结合起来。

要将 'var' 关键字使用偏好设置与所有其他 格式化和 语法样式规则一起应用于选定的代码块， Alt+Enter 并选择 格式化和清理 | 格式化&应用语法样式。

您可以在最近修改并准备提交到 Git 的代码中强制执行 'var' 关键字使用偏好设置。 JetBrains Rider 将在提交之前运行选定的 清理配置文件。

在提交到 Git 之前清理代码

  1. 按 Ctrl+K 或从主菜单中选择 Git | 提交(I)。

  2. 在 提交 工具窗口中，点击 显示提交选项 ，并在 提交检查 区域中，选择 清理方式... 复选框。

  3. 单击 选择配置文件 并选择您的自定义 Code Cleanup 配置文件。

  4. 单击 提交 或 提交并推送。 JetBrains Rider 将在提交暂存的文件中运行代码清理，然后提交更改。

您可以在每次保存文件更改时强制执行 'var' 关键字使用的偏好设置，以确保您的编辑始终符合代码样式。 请注意，这仅在您通过 Ctrl+S 或 Ctrl+S 显式保存更改时发生，不会因 自动保存 而触发。 然而，所有自动保存的文件都会被放入“重新格式化和清理”队列，并将在下次显式保存时处理。

在保存更改时自动强制执行 'var' 关键字使用的偏好设置

  1. 按下 Ctrl+Alt+S 打开设置，然后选择 工具 | 保存时的操作。

  2. 选择 重新格式化并清理代码 ，选择您的自定义 Code Cleanup 配置文件，并决定是将其应用于整个文件还是仅应用于更改的行。

  3. 下次您完成编辑并保存文件或所有文件时，JetBrains Rider 将使用选定的配置文件清理受影响的文件。

配置使用 'var' 关键字的偏好设置

您的 'var' 关键字使用偏好设置是通过 基于层的设置机制保存的。 此外，该机制允许您为不同的解决方案维护不同的偏好，并将这些偏好保存在 VCS 中，自动与团队成员共享。

在设置/偏好设置对话框中配置使用 'var' 关键字的偏好设置

  1. 转到 JetBrains Rider 设置 的 编辑器 | 代码样式 | C# 页面 Ctrl+Alt+S ，然后选择 语法样式 选项卡。

  2. 根据您的编码实践/标准修改 声明中的 'var' 用法 类别中的设置。

    您可以为不同类型设置使用 'var' 或显式类型的不同首选项：

    • 对于内置类型——适用于 C# 内置类型。

    • 对于简单类型——适用于没有泛型参数的类型。

    • 其他地方——适用于泛型类型和解构声明。

    对于这些首选项中的每一项，您可以选择使用 'var'、显式类型或 显而易见时使用 'var'。

  3. 如果您在上一步中选择了 在明显时使用 'var' ，您可以选择应用 Visual Studio 逻辑来决定哪些情况应被视为显而易见。

    要了解 JetBrains Rider 和 Visual Studio 逻辑之间的差异，请参阅 在显而易见时使用 'var'：什么被认为是显而易见的？。

  4. 默认情况下，JetBrains Rider 会建议在 解构声明中对多个 var 使用合并表示法，例如 var (x, y) = GetTuple();。 您可以选择 为析构变量首选单独的声明 以选择单独表示法，例如 (var x, var y) = GetTuple();。

  5. 默认情况下，JetBrains Rider 建议对 丢弃使用独立的 _ ，例如 (_, _) = (0, 1);。 您可以选择 将 'var' 关键字用于弃元 以始终在适当的情况下对丢弃使用 var ，从而确保范围内没有可能命名为 _ 的变量冲突。

  6. 右侧列中的选择器允许您设置检测与您的偏好设置不一致代码的 严重性级别 和 代码检查。

  7. 在 设置 对话框中单击 保存 以应用修改，并让 JetBrains Rider 选择保存位置，或者通过从 保存 选择器中选择特定的设置层来保存修改。 如需了解更多信息，请参见 基于层的设置。

您还可以直接在编辑器中更改使用 'var' 关键字的偏好设置，其中会高亮显示相应的问题：

从编辑器中更改使用 'var' 关键字的偏好设置

  1. 将插入符号放置在 一个 JetBrains Rider 检查突出显示的代码问题上。

  2. 按 Alt+Enter 或单击插入符号左侧的 操作指示器 以打开 操作列表。

  3. 在操作列表中，转到 检查 "使用首选的 'var' 样式" | 配置代码样式 ，然后选择所需的偏好设置：

    更改 'var' 关键字的代码样式偏好

  4. 您的更改将使用 智能保存 逻辑保存。

  5. 如果您需要将修改后的样式偏好保存到 共享设置层 中，请单击 配置代码样式 菜单项或在选中时按 输入 。 JetBrains Rider 将打开 JetBrains Rider 设置 的 编辑器 | 代码样式 | C# | 语法样式 页面，您可以根据需要修改偏好设置，单击 保存到 然后选择所需的设置层。

在显而易见时使用 'var'：什么被认为是显而易见的？

在 配置使用 'var' 关键字与显式类型的首选项时，您可以选择 在明显时使用 'var'。 此选项看起来不言自明，但在某些情况下，可能不清楚什么被认为是“显而易见的”，什么不是。

除此之外，JetBrains Rider 和 Visual Studio 在建议使用 'var' 关键字或显式类型时，对“显而易见”的定义也存在一些差异。

下表显示了根据 JetBrains Rider 设置 编辑器 | 代码样式 | C# | 语法样式 页面上的 为类型证据首选 Roslyn (Visual Studio)逻辑 复选框状态，哪些可以声明为 'var' 的初始化器被认为是显而易见的情况。

初始化器表达式

示例

关

开

对象创建表达式

new MyClass()

显而易见

显而易见

强制转换表达式

(MyClass) obj

显而易见

显而易见

as 表达式

obj as MyClass

显而易见

显而易见

文字表达式

"some string literal"
123
true

显而易见

显而易见

默认表达式

default(MyClass)

显而易见

显而易见

元组表达式

(1, 2, 3)

当所有组件表达式都显而易见时显而易见

显式数组创建表达式

new int[] { 1, 2, 3 }
new MyClass[5]

显而易见

显而易见

隐式数组创建表达式

new [] { 1, 2, 3}
new [,] { {1, 2, 3}, {1, 2, 3}, {1, 2, 3} }

当所有元素初始化器（最多 42 个）显而易见时显而易见

不显而易见

非泛型工厂（创建）方法（在某些类型中声明的静态方法并返回相同类型的值）

MyClass.Build(someArgs) // returns MyClass

当方法名称包含父类型名称或以下子字符串之一时显而易见："Create"、"Build"、"Construct"、"Make"、"Generate"、"Produce"、"New"、"Instance"

显而易见

泛型工厂（创建）方法（返回泛型类型并在与返回类型同名的类中声明的静态方法）

Tuple.Create(1, 2, 3)

当所有方法调用参数显而易见且方法名称包含以下子字符串之一或类名时显而易见："Create"、"Build"、"Construct"、"Make"、"Generate"、"Produce"、"New"、"Instance"

显而易见

转换方法（名称由 "To" 加上返回类型名称组成的方法）

obj.ToString()enumeration.ToList()

当返回类型不是泛型时显而易见

显而易见

具有显式类型参数并返回该类型参数值的泛型方法

obj.GetValue<MyClass>() // returns MyClass

显而易见

不显而易见

枚举成员

KnownColor.Azure

显而易见

不显而易见

单例字段（返回声明它们的类型值的静态/常量字段）

int.MaxValuestring.Empty

当字段名称包含类型名称或以下子字符串之一时显而易见："Empty"、"Instance"、"Default"、"Value"

不显而易见

最后修改日期： 2025年 6月 25日
代码语法样式：文件范围命名空间代码语法样式：修饰符