JetBrains Rider 2025.2 Help

代码语法样式:修饰符

C# 修饰符 的类型和类型成员可以以任意顺序书写。 然而,在整个代码中以类似的方式排列它们是一种良好的实践,这可以提高代码的可读性。 此外,您可能更倾向于显式使用或不使用 隐私内部 修饰符。

JetBrains Rider 帮助您排列现有代码中的修饰符,并在使用 代码补全代码生成功能生成新代码时考虑您的偏好设置,应用 代码模板并执行 重构

在现有代码中排列修饰符

默认情况下,JetBrains Rider 建议显式使用 隐私内部 修饰符,并以特定顺序排列修饰符。 如果需要,您可以 灵活配置这些偏好设置。

如果您的代码不符合这些偏好设置,JetBrains Rider 会高亮显示这些声明,并建议相应的 快速修复范围内修复以调整修饰符的顺序:

排序修饰符

... 对于 隐私 修饰符:

修复隐式 private 修饰符

... 以及对于 内部 修饰符:

修复隐式 internal 修饰符

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

通过代码清理应用修饰符的偏好设置

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

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

  3. 按照 创建新的自定义清理配置文件 部分中描述的步骤创建一个新配置文件。 在新配置文件的 选定的配置文件设置 部分中勾选 对类型使用显式/隐式修饰符对类型成员使用显式/隐式修饰符排序修饰符 复选框。

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

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

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

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

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

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

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

如果您希望在不打开 重新格式化并清理代码 对话框选择配置文件的情况下排列修饰符,可以将创建的配置文件绑定到 静默清理 ,并通过按 Ctrl+R, G 运行它。 您还可以创建一个 自定义清理配置文件 ,将修饰符样式的应用与其他代码样式任务结合起来。

要将修饰符的偏好设置与所有其他 格式化语法样式规则一起应用于选定的代码块, Alt+Enter 并选择 格式化和清理 | 格式化&应用语法样式

您可以排列最近修改并准备提交到 Git 的代码中的修饰符。 JetBrains Rider 将在提交之前运行选定的 清理配置文件

在提交到 Git 之前清理代码

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

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

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

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

您可以在每次保存文件更改时安排修饰符,以确保您的编辑始终符合代码样式。 请注意,这仅在您通过 Ctrl+SCtrl+S 显式保存更改时发生,不会因 自动保存 而触发。 然而,所有自动保存的文件都会被放入“重新格式化和清理”队列,并将在下次显式保存时处理。

在保存更改时自动排列修饰符

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

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

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

配置修饰符的偏好设置

与修饰符相关的偏好设置通过 基于层的设置 机制保存。 此外,该机制允许您为不同的解决方案维护不同的偏好,并将这些偏好保存在 VCS 中,自动与团队成员共享。

配置修饰符的偏好设置

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

  2. 修饰符 类别中,指定修饰符的所需顺序,并设置显式使用 隐私内部 修饰符的偏好。

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

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

您还可以直接在编辑器中更改显式/隐式使用 隐私内部 修饰符的偏好设置,其中相应的问题会被高亮显示:

在编辑器中更改修饰符的偏好设置

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

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

  3. 在操作列表中,选择 检查 "对类型使用显式或隐式修饰符定义" | 更倾向于隐式 'internal' 修饰符

    在编辑器中更改显式/隐式 'internal' 修饰符的偏好设置
  4. 您的更改将使用 智能保存 逻辑保存。

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

  6. 以类似的方式,您可以更改显式/隐式 私有 修饰符的偏好设置。

    在编辑器中更改显式/隐式 'private' 修饰符的偏好设置
最后修改日期: 2025年 9月 26日