重新格式化 XML 文档注释
ReSharper 可以根据您的偏好重新格式化 XML 文档注释。
请注意,ReSharper 不会重新格式化如下的普通注释:
或者
要重新格式化 XML 文档注释,请使用 代码清理。 您可以使用内置配置文件 内置:完全清理运行 代码清理 ,或者使用专门针对您的特定任务的自定义配置文件运行它。
使用自定义代码清理配置文件重新格式化 XML 文档注释
从主菜单中选择 或按下 Alt+R O 。
在 页面上,配置格式设置以符合您的编码实践或标准。
转到清理配置文件设置页面: 。
按照 创建新的自定义清理配置文件 部分中的描述创建一个新配置文件。 在右侧的配置文件首选项中,展开 节点,展开所需语言(C#、Visual Basic .NET 或 JavaScript/TypeScript)的节点,并选择 重新格式化嵌入式 XML 文档注释。
在 选项 对话框中点击 保存 以应用修改,让 ReSharper 选择保存位置,或者通过从 保存到 选择器中选择特定的设置层来保存修改。 有关更多信息,请参见 管理和共享 resharper 设置。
选择您希望重新格式化 XML 文档注释的范围:
将插入符号放置在文件中的任意位置,以将 XML 文档注释重新格式化到文件中。
在 解决方案资源管理器 中选择一个或多个项目,以重新格式化这些节点及其子项下文件中的 XML 文档注释。
执行以下操作之一:
按下 Control+Alt+F 或从主菜单中选择 。
右键单击文本编辑器中的任意位置或右键单击选定内容,并在上下文菜单中选择 清理代码。
在打开的 代码清理 对话框中,选择新创建的配置文件。
单击 运行。 ReSharper 将重新格式化选定范围内的 XML 文档注释。
如果您希望在不打开 代码清理 对话框选择配置文件的情况下重新格式化 XML 文档注释,可以将默认的 重新格式化代码配置文件绑定到 静默清理 ,并通过按 Control+Shift+Alt+F 运行它。 您还可以创建一个 自定义清理配置文件 ,将重新格式化 XML 文档注释与其他代码样式任务结合起来。
此功能在以下语言和技术中是 支持的:
此处提供的说明和示例介绍了在 C# 中使用该功能。 有关其他语言的更多信息,请参阅 语言和框架 部分中的相关主题。