JetBrains Rider 2025.2 Help

重新格式化 XML 文档注释

JetBrains Rider 可以根据您的偏好重新格式化 XML 文档注释

请注意,JetBrains Rider 不会重新格式化以下类型的普通注释:

// A plain single-line comment

或者

/* A plain multi-line comment */

要重新格式化 XML 文档注释,请使用 代码清理。 您可以使用内置配置文件 内置:完全清理运行 代码清理 ,或者使用专门针对您特定任务的自定义配置文件运行它。

使用自定义代码清理配置文件重新格式化 XML 文档注释

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

  2. 编辑器 | 代码样式 | C# | XML 文档注释 页面上,配置格式设置以符合您的编码实践或标准。

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

  4. 按照 创建新的自定义清理配置文件 部分中描述的步骤创建一个新配置文件。 在新配置文件的 选定的配置文件设置 部分中,选择 重新格式化嵌入式 XML 文档注释 复选框,这些复选框适用于 C#、VB.NET 和 JavaScript。 您还可以选择在此配置文件中启用其他代码清理任务。

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

  6. 选择您希望重新格式化 XML 文档注释的范围:

    • 将插入点放置在文件中的任意位置,以将 XML 文档注释重新格式化到该文件。

    • 解决方案资源管理器 中选择一个或多个项目,以重新格式化这些节点及其子项下文件中的 XML 文档注释。

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

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

  9. 点击 确定。 JetBrains Rider 将重新格式化选定范围内的 XML 文档注释。

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

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