ReSharper 2025.2 Help

代码语法样式:命名/位置参数

如果您更喜欢对特定类型的参数使用 命名参数 ,ReSharper 可以帮助您强制执行此实践。

请考虑以下方法调用:

AddCheckbox(true, true, "AutoFill", null);

当您阅读此代码时,您必须暂停并研究方法签名以理解这里发生了什么(您可以通过 参数信息工具提示导航到方法声明来完成此操作)。 使用命名参数,相同的调用变得更加清晰:

AddCheckbox(enabled: true, value: true, label: "AutoFill", tooltip: null);

如果您更喜欢对特定类型使用命名参数,您可以借助 ReSharper 强制执行此偏好。

ReSharper 帮助您在现有代码中排列参数,并在使用 代码补全代码生成功能生成新代码时考虑您的偏好,应用 代码模板并执行 重构

应用参数的样式偏好

默认情况下,ReSharper 建议在所有地方使用位置参数,您必须 明确指定哪些类型的参数需要命名参数。 根据您的偏好,ReSharper 高亮显示需要名称的定位参数或应为定位的命名参数,然后建议相应的 快速修复范围内修复

帮助您添加或移除参数名称的快速修复

即使您对参数没有任何样式偏好,您也可以随时按 Alt+Enter ,在任何命名或位置参数上选择添加或移除参数名称,并使用相应的 上下文操作

添加或移除参数名称的上下文操作

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

使用自定义代码清理配置文件应用参数样式

  1. 从主菜单中选择 ReSharper | 选项 或按 Alt+R O

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

  3. 按照 创建新的自定义清理配置文件 部分的描述创建一个新配置文件。 在新配置文件的 选定的配置文件设置 部分中,勾选 应用参数样式 复选框。 可选地,您可以在此配置文件中启用其他代码清理任务。

  4. 单击 选项 对话框中的 保存 应用修改,让 ReSharper 选择保存位置,或者通过从 保存到 选择器中选择特定的设置层来保存修改。 有关更多信息,请参见 管理和共享 resharper 设置

  5. 选择要强制执行偏好的范围:

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

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

  6. 执行以下操作之一:

    • Control+Alt+F 或从主菜单中选择 ReSharper | 编辑| 清理代码…

    • 右键单击文本编辑器中的任意位置或右键单击选定内容,然后在上下文菜单中选择 清理代码

  7. 在打开的 代码清理 对话框中,选择新创建的配置文件。

  8. 单击 运行。 ReSharper 将在选定范围内强制执行您的偏好。

如果您希望在不打开 代码清理 对话框选择配置文件的情况下排列参数,您可以将创建的配置文件绑定到 静默清理 ,并通过按 Control+Shift+Alt+F 运行它。 您还可以创建一个 自定义清理配置文件 ,将参数排列与其他代码样式任务结合起来。

要将命名/位置参数的偏好与所有其他 格式化语法样式规则一起应用于选定的代码块, Alt+Enter 并选择 重新格式化并清理 | 重新格式化&应用语法样式

您可以在每次保存文件更改时排列参数,以确保您的编辑始终符合代码样式。

在保存更改时自动排列参数

  1. 从主菜单中选择 ReSharper | 选项 或按 Alt+R O

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

  3. 选择您的自定义代码清理配置文件并单击 设为默认 (默认配置文件也用于 静默清理)。

  4. 转到 代码编辑 | 代码清理 | 常规 选项页面并选择 保存文件时自动运行清理

    可选地,您可以通过文件掩码限制自动清理到特定文件。

    您还可以选择 仅更改的文件部分 ,以确保清理仅应用于受更改影响的代码,而文件中的其余代码不会被修改。

    如果您选择仅清理文件的更改部分,可以通过以下选项微调此行为:

    • 如果无法执行部分清理,则执行完全清理 — 根据此选项,ReSharper 将清理整个文件,或者如果无法将清理限制为文件的修改部分,则跳过该文件。

    • 允许在保存共享文件时进行清理 — 使用此选项启用或禁用对多次包含在解决方案中的文件(例如共享项目中的文件)的部分清理。

  5. 在对话框中单击 保存 以应用修改,并让 ReSharper 选择保存位置,或者通过从 保存到 选择器中选择特定的设置层来保存修改。 有关更多信息,请参见 管理和共享 resharper 设置

  6. 下次您完成编辑并保存文件( Ctrl+S )或所有文件( Ctrl+Shift+S )时,ReSharper 将使用选定的配置文件清理受影响的文件。 如果未选择 默认清理配置文件 ,ReSharper 将提示您选择一个配置文件。

配置命名/位置参数的偏好

您的参数样式偏好是使用 基于层的设置机制保存的。 除此之外,该机制还允许您为不同的解决方案维护不同的偏好,并将这些偏好保存在 VCS 中,自动与团队成员共享。

配置参数样式的偏好

  1. 转到 ReSharper 选项 的 代码编辑 | C# | 语法样式 页面 Alt+R, O

  2. 实参 类别中,选择是否对特定参数类型使用命名或位置参数。 请注意, 字面量值 指的是所有文字(布尔整数double 等),字符串除外。 字符串的偏好在 字符串字面量值 选择器中定义。

    其它 类别适用于所有其他表达式类型,例如条件、空合并、二元、调用或 类型 表达式。

  3. 右侧列中的 通知方式 选择器允许您设置 严重性级别 ,以检测与您的偏好不一致的 代码检查

  4. 单击 选项 对话框中的 保存 应用修改,让 ReSharper 选择保存位置,或者通过从 保存到 选择器中选择特定的设置层来保存修改。 有关更多信息,请参见 管理和共享 resharper 设置

您还可以直接在编辑器中更改排列参数的偏好,其中相应的问题会被高亮显示。

在编辑器中更改命名/位置参数的偏好

  1. 将光标放置在 一个 ReSharper 检查高亮显示的代码问题上。

  2. Alt+Enter 或单击光标左侧的 操作指示器以打开 操作列表

  3. 在操作列表中,选择 检查 "使用首选参数样式..." | 配置代码样式 ,然后选择所需的选项:

    在编辑器中更改命名/位置参数偏好的操作
  4. 您的更改将使用 智能保存逻辑保存。

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

此功能在以下语言和技术中 受支持

语言:C#

语言:VB.NET

语言:C++

语言:ASP.NET

语言:Razor

语言:XAML

语言:Resx

语言:构建脚本

语言:SQL

此功能在 C# 中可用

此功能在 Visual Basic 中不可用

功能在 C++ 中不可用

此功能在 ASP.NET 中不可用

此功能在 Razor 中不可用

此功能在 XAML 中不可用

此功能在资源文件中不可用

此功能在构建脚本文件中不可用

此功能在 SQL/NoSQL 文件和注入中不可用

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