什么是“代码清理”?
“代码清理”是 Visual Studio 提供的一项便捷功能,用于在代码文件中执行一系列格式化和修正任务,如应用编辑规范、删除冗余 using 语句、整理命名或添加访问修饰符,帮助维护代码一致性与可读性。
如何配置代码清理?
Visual Studio 提供了两个可配置的清理“配置文件”(Profile),默认命名为 Profile 1 和 Profile 2。通过“配置代码清理”对话框,你可以为每个配置文件指定希望执行的操作步骤,例如删除未使用的 using、格式化文档、转换成文件作用域的命名空间、统一命名约定、设置字段为只读、添加访问修饰词等。
配置步骤如下:
- 打开 Tools > Options > Text Editor > Code Cleanup(或点击编辑器底部的“代码清理”扫把图标旁的小箭头选择“配置代码清理”)。
- 选择或编辑 Profile 1 或 Profile 2,勾选或取消对应的清理操作项。
- 保存配置后,清理配置文件即设置完成。
如何执行代码清理?
你可通过以下方式快速运行代码清理:
在编辑器中,直接点击底部的扫把图标,或使用快捷键 Ctrl + K, Ctrl + E。
如果需要清理整个项目或解决方案,可在“解决方案资源管理器”中右键项目或方案名称,选择 Analyze and Code Cleanup,再选择运行相应配置文件。
“保存时自动清理”功能
Visual Studio 2022 及后续版本支持在保存文件时自动执行代码清理,让代码格式保持一致更轻松无感。只需前往 Tools > Options > Text Editor > Code Cleanup,勾选“Run Code Cleanup profile on Save”,并选择默认为保存时执行的清理配置文件即可开启此功能。之后每当你保存 C# 文件,系统便会自动清理格式与样式。
.editorconfig 支持与清理规则
若项目中包含 .editorconfig 文件,其中定义的代码风格(比如缩进、括号格式、using 排序等)会在代码清理时优先被使用。这意味着团队通过 .editorconfig 可统一风格,并让 Code Cleanup 执行这些规则一致地清理代码。
你还可根据需要勾选代码清理配置中涉及的具体项目,如:
- 删除未使用的 using
- 排序 using 语句
- 格式化文档内容
- 应用文件头模板
- 删除未使用的变量或参数
- 使用对象初始化器简化代码
- 添加缺失的访问修饰符
- 将字段设置为只读
- 简化布尔或插值表达式
- 优化 null 检查写法,等等
通过配置不同动作组合,代码清理能帮你执行一系列标准化代码的任务,操作方便、高效且一致。
代码清理功能使用建议
- 定期清理:在提交代码前建议运行代码清理,保持风格一致、减少审查花费。
- 团队协作:建议统一使用 .editorconfig 文件,并配置代码清理,确保团队代码风格一致。
- 区别配置文件用途:可将 Profile 1 设置为基本格式化,Profile 2 包含更深层清理(如删除未使用成员、添加修饰符等),按场景选择使用。
- 保存时自动清理:适合日常开发流程,减少手动格式化干预;但仍可临时关闭或修改配置,以防意外修改代码结构。