JetBrains Rider 2025.1 Help

文件头样式

使用文件头来记录版权声明和其他标识信息是一种常见做法。 JetBrains Rider 允许您配置默认的文件头文本，并将其自动插入到源文件中，或用它替换现有的文件头。

您可以在 JetBrains Rider 设置 或 .editorconfig 文件 中配置文件头样式，然后将其添加到使用 文件模板 创建的新文件中，并使用 代码清理 插入或替换现有文件中的文件头。

为了确保由不同团队成员创建和编辑的文件具有相同的文件头样式，请与您的团队 共享文件头设置。

如果您不确定是在 JetBrains Rider 设置 中还是在 .editorconfig 文件中配置文件头样式，请参考以下表格。

优点

缺点

JetBrains Rider 设置

  • 可视化编辑器。

  • 灵活的变量配置。

  • 能够在新头部文本中重用现有文件头。

  • 能够在 C# 文件中将头部包裹在 #region .. #endregion 中。

.editorconfig

  • 可用于支持 EditorConfig 格式的不同 JetBrains 和非 JetBrains 产品。

  • 可应用于更多语言。

  • 对变量的支持仅限于可以在不同 .editorconfig 文件中定义的常量。

  • 无法重用现有文件头。

在 JetBrains Rider 设置中配置文件头

  1. 按 Ctrl+Alt+S 或从菜单中选择 文件 | 设置 （Windows 和 Linux）或 JetBrains Rider | 首选项 （macOS），然后在左侧选择 编辑器 | 文件头模板。

  2. 在 文件头文本 选项卡中，输入您希望插入到源文件开头的文本。

    您不需要在文件头文本中包含注释分隔符。 应用头部模板时，JetBrains Rider 会自动为特定语言插入适当的分隔符。

  3. 要添加变量信息（如日期、时间或贡献者姓名），请使用相应的宏。 可用宏的列表显示在右侧部分。 要使用宏，请在头部正文中键入它，或单击右侧部分的相应宏以将其插入到当前光标位置。

    在 文件头变量 选项卡中，您可以指定要在头部文本中重用的常量值。 例如，您可以添加一个名称为 companyName 且值为 My company 的变量，然后在头部模板中以 $Variable.Named($"{companyName}") 的形式使用它。

  4. 应用文件头模板时，默认情况下 JetBrains Rider 会自动检测文件中的初始注释（如果有），将其视为现有文件头，并用指定的文件头替换它们。

    如果您想限制此行为，仅将特定注释视为文件头，请编辑 文件头开始检测正则表达式 字段中的正则表达式。 例如，您可以将其更改为 版权 .* ，以仅匹配以 版权 开头的初始注释。

    如果您想重用通过正则表达式匹配的现有头部，请在文件头模板中的所需位置添加 ${OldHeader.Text} 宏。

  5. 可选地，要在 C# 中用 #region .. #endregion 包围文件头，请在 将文件头包含到具有名称的区域中 字段中输入区域名称。

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

通过 EditorConfig 配置文件头

  1. 打开您想要配置文件头的 .editorconfig 文件，或创建一个新文件。

  2. 将 file_header_template 属性添加到文件中，例如：

    file_header_template=Your Company. \nSome info about {fileName}

将文件头添加到新创建的文件中

  1. 创建一个新的文件模板或编辑一个现有模板以添加文件头。

  2. 在模板的开头 添加一个模板参数 ，并将其与“文件头” 宏关联。

    JetBrains Rider：带有文件头的文件模板

  3. 保存模板。

  4. 使用此模板 创建的新文件将具有指定的文件头。

使用代码清理将文件头插入到现有文件中

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

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

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

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

  5. 选择您想要更新文件头的范围：

    • 将光标放置在文件中的任意位置以更新该文件的文件头。

    • 在 解决方案资源管理器 中选择一个或多个项目，以更新这些节点及其子项下文件的文件头。

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

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

  8. 点击 确定。 JetBrains Rider 将更新选定范围内的文件头。

  9. 如果您想在不打开 重新格式化并清理代码 对话框选择配置文件的情况下更新文件头，可以将创建的配置文件绑定到 静默清理 ，并通过按 Ctrl+R, G 运行它。 您还可以创建一个 自定义清理配置文件 ，将插入文件头与其他代码样式任务结合起来。

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

在提交到 Git 之前清理代码

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

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

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

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

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

在保存更改时自动更新文件头

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

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

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

在团队中共享文件头样式

  • 如果您通过 .editorconfig配置文件头，请确保相应的 .editorconfig 文件已添加到版本控制系统中。

  • 如果您通过 JetBrains Rider 设置配置文件头，请将您的配置更改保存到 “解决方案团队共享”设置层 ：完成所需更改后，在 设置 对话框中的 保存 选择器中选择 解决方案 'solutionName' 团队共享。

    确保 <SolutionName>.sln.DotSettings 文件已添加到版本控制系统中。

2025年 7月 31日
命名样式使用文件和类型布局模式重新排列成员