代码语法样式:可选成员限定符
在 C# 中,您可以使用 this 关键字限定实例成员,并使用类型名称或基类型名称限定静态成员。 这些限定符可以帮助您区分被 局部变量或 方法参数隐藏的成员。 在所有其他情况下,这些修饰符是可选的,您可以自行决定是否使用它们。 使用 JetBrains Rider,您可以配置对可选修饰符的使用偏好并强制执行这些偏好。
JetBrains Rider 帮助您调整现有代码中的可选成员限定符,并在使用 代码补全 和 代码生成 功能生成新代码时,应用 代码模板 并执行 重构 时,考虑您的偏好。
强制执行可选成员限定符的样式偏好
默认情况下,JetBrains Rider 将所有可选成员限定符视为多余,并建议移除它们。

如果您更喜欢使用可选限定符,则需要按照以下描述明确指定。 例如,您可能更喜欢使用声明它们的类型限定静态方法:

一旦您更改了偏好设置,JetBrains Rider 将以不同的方式处理相同的代码,并建议相应的更正:

另一种批量强制执行成员限定符偏好的方法是使用 代码清理。 您可以使用内置的配置文件之一 运行代码清理 ,例如 完全清理或 重新格式化并应用语法样式 ,或者创建并运行 仅针对特定任务的自定义配置文件 ,如下所述。
使用自定义代码清理配置文件应用成员限定符偏好
按下 Ctrl+Alt+S 或从菜单中选择 (Windows 和 Linux)或 (macOS)。
转到代码清理配置文件设置页面: 。
按照 创建新的自定义清理配置文件 部分中描述的步骤创建一个新配置文件。 在新配置文件的 选定的配置文件设置 部分中,勾选 排列限定符 复选框。 您还可以选择在此配置文件中启用其他代码清理任务。
在 设置 对话框中点击 保存 以应用修改,并让 JetBrains Rider 选择保存位置,或者通过从 保存 选择器中选择特定设置层来保存修改。 如需了解更多信息,请参见 基于层的设置。
选择您希望强制执行偏好的范围:
将光标放置在文件中的任意位置,以对文件强制执行您的偏好设置。
在 解决方案资源管理器 中选择一个或多个项目,以对这些节点及其子项下的文件强制执行您的偏好设置。
按 Ctrl+R, C 或从主菜单中选择 。
在打开的 重新格式化并清理代码 对话框中,选择新创建的配置文件,并根据需要选择另一个范围。 在打开的 重新格式化并清理代码 对话框中,选择新创建的配置文件,并在需要时选择其他作用域。
点击 确定。 JetBrains Rider 将在选定范围内强制执行您的偏好设置。
如果您希望在不打开 重新格式化并清理代码 对话框选择配置文件的情况下应用成员限定符偏好,可以将创建的配置文件绑定到 静默清理 ,并通过按 Ctrl+R, G 运行它。 您还可以创建一个 自定义清理配置文件 ,将应用偏好设置与其他代码样式任务结合起来。
要将可选成员限定符的偏好与所有其他 格式化 和 语法样式 规则一起应用于选定的代码块, Alt+Enter 并选择 。
您可以调整最近修改并准备提交到 Git 的代码中的可选成员限定符。 JetBrains Rider 将在提交之前运行选定的 清理配置文件。
在提交到 Git 之前清理代码
按 Ctrl+K 或从主菜单中选择 。
在 提交 工具窗口中,点击
,并在 提交检查 区域中,选择 清理方式... 复选框。
点击 选择配置文件 并选择您的自定义 Code Cleanup 配置文件。
点击 提交 或 提交并推送。 JetBrains Rider 将在提交暂存的文件中运行代码清理,然后提交更改。
您可以在每次保存文件更改时调整可选成员限定符,以确保您的编辑始终符合代码样式。 请注意,这仅在您通过 Ctrl+S 或 Ctrl+S 显式保存更改时发生,不会因 自动保存 而触发。 然而,所有自动保存的文件都会被放入“重新格式化和清理”队列,并将在下次显式保存时处理。
在保存更改时自动调整可选成员限定符
按下 Ctrl+Alt+S 打开设置,然后选择 。
选择 重新格式化并清理代码 ,选择您的自定义 Code Cleanup 配置文件,并决定是将其应用于整个文件还是仅应用于更改的行。
下次您完成编辑并保存文件或所有文件时,JetBrains Rider 将使用选定的配置文件清理受影响的文件。
配置可选成员限定符的偏好
您的成员限定符样式偏好是通过 基于层的设置 机制保存的。 此外,该机制允许您为不同的解决方案维护不同的偏好,并将这些偏好保存在 VCS 中,自动与团队成员共享。