ReSharper 2025.2 Help

重新格式化 XML 文档注释

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

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

// A plain single-line comment

或者

/* A plain multi-line comment */

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

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

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

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

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

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

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

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

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

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

  7. 执行以下操作之一:

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

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

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

  9. 单击 运行。 ReSharper 将重新格式化选定范围内的 XML 文档注释。

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

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

语言:C#

语言:VB.NET

语言:C++

语言:ASP.NET

语言:Razor

语言:XAML

语言:Resx

语言:构建脚本

语言:SQL

此功能在 C# 中可用

此功能在 Visual Basic 中可用

功能在 C++ 中不可用

此功能在 ASP.NET 中不可用

此功能在 Razor 中不可用

此功能在 XAML 中不可用

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

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

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

此处提供的说明和示例针对在 C# 中使用该功能。 有关其他语言的更多信息,请参阅 语言和框架 部分中的相应主题。

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