C# 快速操作和重构
Visual Studio Code 提供了多种重构源代码的方式,以及在编写代码时生成代码和修复问题的快速修复。要访问它们,可以单击出现的“灯泡”图标,或使用“快速修复”命令 ⌘. (Windows, Linux Ctrl+.) 来显示快速修复和重构选项列表。您也可以右键单击编辑器,然后选择“重构” ⌃⇧R (Windows, Linux Ctrl+Shift+R),仅显示重构选项。
支持的重构和快速修复
- 添加
await
- 从成员添加构造函数参数
- 添加
DebuggerDisplay
特性 - 添加显式转换
- 添加文件头
- 添加缺失的
usings
/ 导入 - 添加命名参数
- 将匿名类型转换为类
- 在自动属性和完整属性之间转换
- 在直接转换和
as
表达式之间转换 - 在
for
循环和foreach
语句之间转换 - 在 Get 方法和属性之间转换
- 在
if
和switch
语句之间转换 - 在常规字符串和逐字字符串之间转换
- 将类转换为 record
- 将本地函数转换为方法
- 将数字字面量转换为十六进制、十进制或二进制数
- 将占位符转换为内插字符串
- 将常规字符串转换为内插字符串
- 将元组转换为 struct
- 封装字段
- 生成比较运算符
- 生成默认构造函数
- 生成参数
- 显式实现所有成员
- 隐式实现所有成员
- 内联方法
- 内联临时变量
- 为表达式引入本地变量
- 引入参数
- 引入
using
语句 - 反转条件表达式和逻辑操作
- 反转
if
- 将成员设置为 static
- 将声明移动到引用附近
- 将类型移动到匹配文件
- 反转
for
语句 - 拆分或合并
if
语句 - 使用显式类型
- 使用隐式类型
- 使用 lambda 表达式或块体
- 使用递归模式
- 换行、缩进和对齐重构
添加 await
功能: 向函数调用添加 await
关键字。
时机: 在异步方法中调用函数时。
操作方法
- 将光标放在函数调用旁边(很可能会标有红色下划线)。
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 选择添加
await
。
从成员添加构造函数参数
功能: 基于选定的类成员生成带有参数的新构造函数。
时机: 引入新构造函数并希望自动正确声明所有正确参数时。
原因: 您可以在使用构造函数之前声明它,但此功能会自动生成它。
操作方法
- 突出显示要在构造函数中添加为参数的类成员。
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 选择生成构造函数 <classname>(<membertype>, <membertype>, <etc.>)。
添加 DebuggerDisplay 特性
功能: DebuggerDisplay 特性 控制对象、属性或字段在调试器变量窗口中的显示方式。
时机: 您想在代码中以编程方式在调试器中固定属性时。
原因: 固定属性允许您通过将该属性向上冒泡到对象属性列表的顶部,从而在调试器中快速通过属性检查对象。
操作方法
- 将光标放在类型、委托、属性或字段上。
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单并选择添加
DebuggerDisplay
特性。 DebuggerDisplay
特性与返回默认ToString()
的自动方法一起添加。
添加显式转换
功能: 允许您根据用法自动向表达式添加显式转换。
时机: 您需要向表达式添加显式转换并希望自动正确分配时。
原因: 您可以手动向表达式添加显式转换,但此功能会根据代码上下文自动添加它。
操作方法
- 将光标放在错误上。
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 选择添加显式转换。
添加文件头
功能: 使用 EditorConfig 向现有文件、项目和解决方案添加文件头。
时机: 您想轻松地向文件、项目和解决方案添加文件头时。
原因: 您的团队要求您包含文件头用于版权目的。
操作方法
- 如果您还没有 EditorConfig,请将其添加到项目或解决方案中。
- 将以下规则添加到您的 EditorConfig 文件中:
file_header_template
。 - 将规则的值设置为您想要应用的文件头文本。您可以使用
{fileName}
作为文件名的占位符。 - 将光标放在任何 C# 文件的第一行。
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 选择添加文件头。
添加缺失的 using / 导入
功能: 允许您立即为复制粘贴的代码添加必要的导入或 using 指令。
时机: 将代码从项目中的不同位置或其他源复制并粘贴到新代码中是常见的做法。此快速操作会查找复制粘贴代码中缺失的导入指令,然后提示您添加它们。此代码修复还可以添加项目之间的引用。
原因: 因为快速操作会自动添加必要的导入,您无需手动复制代码所需的 using 指令。
操作方法
- 将代码从一个文件复制并粘贴到新文件,而未包含必要的 using 指令。生成的错误会伴随一个代码修复,该修复会添加缺失的 using 指令。
- 选择 ⌘. (Windows, Linux Ctrl+.) 打开快速操作和重构菜单。
- 选择使用 <your reference> 添加缺失的引用。
添加命名参数
功能: 在函数调用中为指定的参数值追加一个命名参数。
时机: 如果您有一个有很多参数的方法,您可以添加命名参数以提高代码的可读性。
操作方法
- 将光标放在函数调用中的参数内。
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 选择添加参数名 <parameter name>。
将匿名类型转换为类
功能: 将匿名类型转换为类。
时机: 您有一个匿名类型,希望继续在类中构建时。
原因: 如果只在本地使用匿名类型,它们会很有用。随着代码的增长,能方便地将其提升为类是件好事。
操作方法
- 将光标放在匿名 (
var
) 类型中。 - 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 选择转换为类。
在自动属性和完整属性之间转换
功能: 在自动实现的属性和完整属性之间转换。
时机: 属性的逻辑已更改时。
原因: 您可以手动在自动实现的属性和完整属性之间转换,但此功能会自动为您完成工作。
操作方法
- 将光标放在属性名称上。
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 从以下两个选项中选择
选择转换为完整属性。
选择使用自动属性。
在直接转换和 'as' 表达式之间转换
功能: 在常规转换和使用 as
关键字的尝试转换之间转换变量。
时机: 当您预期转换在某些场景下会失败 (as
) 或从未预期转换会失败(直接转换)时。
操作方法
- 将光标放在变量上。
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 从以下两个选项中选择
选择更改为转换。
选择更改为 as
表达式。
在 for 循环和 foreach 语句之间转换
功能: 如果代码中有 for 循环,可以使用此重构将其转换为 foreach 语句。
原因: 可能希望将 for 循环转换为 foreach 语句的原因包括
- 您除了将本地循环变量用作访问项的索引外,没有在循环内使用它。
- 您希望简化代码并减少在初始化器、条件和迭代器部分出现逻辑错误的可能性。
可能希望将 foreach 语句转换为 for 循环的原因包括
- 您希望在循环内使用本地循环变量,而不仅仅是访问项。
- 您正在遍历多维数组,并希望对数组元素有更多的控制。
操作方法
- 将光标放在
foreach
或for
关键字中。 - 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 从以下两个选项中选择
选择转换为 for
。
选择转换为 foreach
。
在 Get 方法和属性之间转换
将 Get 方法转换为属性
功能: 允许您将 Get 方法转换为属性(可选地也可以转换 Set 方法)。
时机: 您有一个不包含任何逻辑的 Get 方法时。
操作方法
- 将光标放在 Get 方法名称中。
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- (可选)如果您有 Set 方法,也可以此时转换您的 Set 方法。选择将 <Get method or Set method name> 替换为属性。
将属性转换为 Get 方法
功能: 允许您将属性转换为 Get 方法
时机: 您有一个涉及不仅仅是立即设置和获取值的属性时
操作方法
- 将光标放在 Get 方法名称中。
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 选择将 <property name> 替换为方法。
在 if 和 switch 语句之间转换
功能: 将 if
语句转换为 switch 语句 或 C# 8.0 switch 表达式。
时机: 您想将 if
语句转换为 switch
语句或 switch
表达式,反之亦然时。
原因: 如果您正在使用 if
语句,此重构可以轻松转换为 switch 语句或 switch 表达式。
操作方法
- 将光标放在
if
关键字中。 - 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 从以下选项中选择
选择转换为 switch
语句。
选择转换为 switch
表达式。
选择转换为 if
语句。
在常规字符串和逐字字符串之间转换
功能: 允许您在常规字符串和逐字字符串字面量之间转换。
时机: 您想节省空间或提高代码清晰度时。
原因: 将逐字字符串字面量转换为常规字符串字面量有助于节省空间。将常规字符串字面量转换为逐字字符串字面量可以提供更高的清晰度。
操作方法
- 将光标放在常规字符串或逐字字符串字面量上
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 从以下选项之一中选择
选择转换为常规字符串。
选择转换为逐字字符串。
将类转换为 record
功能: 将类转换为 C# record。
时机: 当您想快速将类更改为 record 时,record 适用于存储数据和不可变性。
操作方法
- 将光标放在类名称上。
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 选择转换为位置 record。
将本地函数转换为方法
功能: 将本地函数转换为方法。
时机: 您有一个本地函数,想在当前本地上下文之外定义时。
原因: 您想将本地函数转换为方法,以便在本地上下文之外调用它。当您的本地函数变得太长时,您可能想要将其转换为方法。将函数定义在单独的方法中,代码更容易阅读。
操作方法
- 将光标放在本地函数中。
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 选择转换为方法。
将数字字面量转换为十六进制、十进制或二进制数
功能: 在十六进制、二进制或十进制数之间转换数字。
时机: 当您想自动将数字转换为所需基数,而无需手动计算转换时使用。
操作方法
- 将光标放在数字字面量上。
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 选择以下选项之一
选择转换为十进制。
选择转换为十六进制。
选择转换为二进制。
将占位符转换为内插字符串
功能: 将 String.Format
格式化的结果字符串(或占位符)转换为内插字符串。
时机: 当您想快速获得内插字符串时使用。
原因: 内插字符串可以提供更易读的 String.Format
版本,并允许您直接访问变量名。
操作方法
- 将光标放在
String.Format
占位符上。 - 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 选择转换为内插字符串。
将常规字符串转换为内插字符串
功能: 将常规字符串更改为内插字符串。
时机: 当您想清理代码并使其更易读时使用。
操作方法
- 将光标放在您要转换的字符串上。
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 选择转换为内插字符串。
将元组转换为 struct
功能: 将元组转换为 struct
时机: 当您想快速将元组更改为 struct
并希望拥有可多次访问的固定数据时使用。
操作方法
-
将光标放在元组上。
-
按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
-
选择以下选项之一
- 选择转换为
struct
-> 更新包含成员中的用法 - 选择转换为
struct
-> 更新包含类型中的用法 - 选择转换为
struct
-> 更新包含项目中的用法 - 选择转换为
struct
-> 更新依赖项目中的用法
- 选择转换为
封装字段
功能: 允许您将字段转换为属性,并更新该字段的所有用法以使用新创建的属性。
时机: 您想将字段移动到属性并更新对该字段的所有引用时。
原因: 您想允许其他类访问字段,但不希望这些类直接访问。通过将字段包装在属性中,您可以编写代码来验证正在赋的值,例如。
操作方法
- 将光标放在要封装的字段名称内。
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 选择以下之一
选择封装字段:<fieldname>(并使用属性)。
选择封装字段:<fieldname>(但仍使用字段)。
生成比较运算符
功能: 允许您为实现 IComparable
的类型生成比较运算符。
时机: 您有一个实现 IComparable
的类型时,我们将自动添加比较运算符。
原因: 如果您正在实现值类型,则应考虑重写 Equals
方法,以便获得比 ValueType
上 Equals
方法的默认实现更高的性能。
操作方法
- 将光标放在类内或 IComparable 关键字上。
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 从下拉菜单中选择生成比较运算符。
生成默认构造函数
功能: 允许您立即为类上的新默认构造函数生成代码。
时机: 您引入新的默认构造函数并希望自动正确声明它时。
原因: 您可以在使用构造函数之前声明它,但此功能会自动生成它。
操作方法
- 将光标放在类名称上。
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 选择生成构造函数 <classname>()。
生成参数
功能: 自动生成方法参数。
时机: 在方法中引用当前上下文中不存在的变量并收到错误时;您可以将参数作为代码修复生成。
原因: 您可以快速修改方法签名而不会丢失上下文。
操作方法
- 将光标放在变量名中。
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 选择生成参数。
显式实现所有成员
功能: 在类中显式定义接口的方法。显式接口实现是通过指定接口调用的类成员。
时机: 在以下情况使用
- 您不想对多个接口调用相同的实现时。
- 您想解决两个接口各自声明具有相同名称但不同成员(例如属性和方法)的情况时。
操作方法
- 将光标放在类中正在实现的接口上。
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 选择显式实现所有成员
隐式实现所有成员
功能: 在类中隐式定义接口的方法。隐式接口实现是指接口的方法和属性直接作为公共方法添加到类中。
操作方法
- 将光标放在类中正在实现的接口上。
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 选择实现接口
内联方法
功能: 内联方法重构。
时机: 您想将单个语句体中静态方法、实例方法和扩展方法的用法替换为选项以删除原始方法声明时。
原因: 此重构提供了更清晰的语法。
操作方法
- 将光标放在方法的用法上。
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 从以下选项之一中选择
选择内联 <QualifiedMethodName> 以删除内联方法声明
选择内联并保留 <QualifiedMethodName> 以保留原始方法声明
内联临时变量
功能: 允许您移除临时变量并将其替换为其值。
时机: 使用临时变量使代码更难理解时。
原因: 移除临时变量可能使代码更易读。
操作方法
- 将光标放在要内联的临时变量内。
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 选择内联临时变量。
为表达式引入本地变量
功能: 允许您立即生成本地变量以替换现有表达式。
时机: 您有一些代码,如果放在本地变量中,以后很容易重用时。
原因: 您可以多次复制粘贴代码以在不同位置使用,但更好的做法是执行一次操作,将结果存储在本地变量中,并在代码中使用该本地变量。
操作方法
- 将光标放在要分配给新本地变量的表达式上。
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 从以下选项中选择
选择引入本地变量 -> 为 <expression> 引入本地变量
选择引入本地变量 -> 为 <expression> 的所有出现项引入本地变量
引入参数
功能: 允许您立即生成新参数以替换现有表达式。
时机: 您有一些代码,如果放在参数中,以后很容易重用时。
原因: 您可以多次复制粘贴代码以在不同位置使用,但更好的做法是执行一次操作,将结果存储在参数中,并在代码中使用该参数。
操作方法
- 将光标放在要分配给新参数的表达式上。
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 从以下选项中选择
选择为 <expression> 引入参数 -> 并直接更新调用位置
选择为 <expression> 引入参数 -> 提取到方法中
选择为 <expression> 引入参数 -> 创建新的重载
引入 using
语句
功能: 向 IDisposable
实例添加 using
语句 / 代码块。
时机: 您有一个 IDisposable
实例,并希望确保它被正确获取、使用和释放时。
操作方法
- 将光标放在要分配给新参数的表达式上。
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 选择引入
using
语句。
反转条件表达式和逻辑操作
功能: 允许您反转条件表达式或条件 and
\ or
运算符。
时机: 您有一个条件表达式或条件 and
\ or
运算符,反转后会更容易理解时。
原因: 手动反转表达式或条件 and
\ or
运算符可能需要更长时间并可能引入错误。此代码修复可帮助您自动完成此重构。
操作方法
- 将光标放在条件表达式或条件
and
\or
运算符中。 - 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 选择反转条件或将
&&
替换为||
反转 if
功能: 允许您反转 if
或 if else
语句,而不会改变代码的含义。
时机: 当您有一个 if
或 if else
语句,反转后会更容易理解时。
原因: 手动反转 if
或 if else
语句可能需要更长时间并可能引入错误。此代码修复可帮助您自动完成此重构。
操作方法
- 将光标放在
if
或if else
语句中。 - 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 选择反转
if
。
将成员设置为 static
功能: 将成员设为 static。
时机: 您想将非静态成员设为 static 时。
原因: 静态成员提高了可读性:知道特定代码是隔离的,使其更容易理解、重读和重用。
操作方法
- 将光标放在成员名称上。
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 选择设为 static。
将声明移动到引用附近
功能: 允许您将变量声明移动到更靠近其用法的位置。
时机: 您有一些可以在更窄范围内的变量声明时。
原因: 您可以保持原样,但这可能会导致可读性问题或信息隐藏。这是一个通过重构提高可读性的机会。
操作方法
- 将光标放在变量声明中。
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 选择将声明移动到引用附近。
将类型移动到匹配文件
功能: 允许您将选定的类型移动到同名的新文件中。
时机: 您在同一个文件中有多个类、结构、接口等,并且希望将其分开时。
原因: 将多个类型放在同一个文件中会使其难以查找。将类型移动到同名文件中,代码将更易读且更易于导航。
操作方法
- 将光标放在定义类型的名称内。
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 选择将类型移动到 <typename>.cs。
反转 for 语句
功能: 允许您反转 for
语句。
时机: 当您想反转 for
语句的含义及其迭代方式时使用。
原因: 手动反转 for
语句可能需要更长时间并可能引入错误。此代码修复可帮助您自动完成此重构。
操作方法
- 将光标放在
for
语句中。 - 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 选择反转
for
语句。
拆分或合并 if 语句
功能: 拆分或合并 if
语句。
时机: 您想将使用 &&
或 ||
运算符的 if
语句拆分成嵌套的 if
语句,或将 if
语句与外部 if
语句合并时。
原因: 这是风格偏好问题。
操作方法
如果要拆分 if
语句
- 将光标放在
if
语句中&&
或||
运算符旁边。 - 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 选择拆分为嵌套的
if
语句。
如果要将内部 if
语句与外部 if
语句合并
- 将光标放在内部
if
关键字中。 - 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 选择与嵌套的
if
语句合并。
使用显式类型
功能: 使用此重构将本地变量声明中的 var
替换为显式类型。
原因: 为了提高代码的可读性,或者当您不想在声明中初始化变量时。
但是,当变量使用匿名类型初始化并且稍后访问对象的属性时,必须使用 var。有关详细信息,请参阅 隐式类型本地变量 (C#)。
操作方法
- 将光标放在
var
关键字上。 - 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 选择使用显式类型而不是
var
。
使用隐式类型
功能: 使用此重构将本地变量声明中的显式类型替换为 var
。
原因: 为了符合您的个人编码约定并减少显示的 代码。当变量使用匿名类型初始化并且稍后访问对象的属性时,必须使用 Var。有关详细信息,请参阅 隐式类型本地变量 (C#)。
操作方法
- 将光标放在显式类型关键字上。
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 选择使用隐式类型。
使用 lambda 表达式或块体
功能: 允许您重构 lambda 表达式以使用表达式体或块体。
时机: 您偏好 lambda 表达式使用表达式体或块体时。
原因: 可以重构 lambda 表达式,根据用户偏好提高可读性。
操作方法
- 将光标放在 lambda 运算符的右侧。
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 选择以下之一
选择为 lambda 表达式使用块体。
选择为 lambda 表达式使用表达式体。
使用递归模式
功能: 将代码块转换为使用递归模式。此重构适用于 switch 语句、属性模式匹配、元组模式匹配和位置模式匹配。
时机: 使用递归模式可以使代码更易读/更简洁。
操作方法
- 将光标放在要转换为递归模式的表达式上。
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 选择以下之一
选择将 switch
语句转换为表达式。
选择使用递归模式。
换行、缩进和对齐重构
换行并对齐调用链
功能: 允许您换行并对齐方法调用链。
时机: 您在一个语句中包含由多个方法调用组成的很长的链时。
原因: 根据用户偏好对长列表进行换行或缩进后,更容易阅读。
操作方法
- 将光标放在任何调用链中。
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 选择换行调用链或换行并对齐调用链以接受重构。
换行、缩进和对齐参数或实参
功能: 允许您换行、缩进和对齐参数或实参。
时机: 您有一个方法声明或调用,其中包含多个参数或实参时。
原因: 根据用户偏好对长参数或实参列表进行换行或缩进后,更容易阅读。
操作方法
- 将光标放在参数列表中。
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 从以下选项中选择
选择换行每个参数 -> 对齐换行参数
选择换行每个参数 -> 缩进所有参数
选择换行每个参数 -> 缩进换行参数
换行二元表达式
功能: 允许您换行二元表达式。
时机: 您有一个二元表达式时。
原因: 根据用户偏好对二元表达式进行换行后,更容易阅读。
操作方法
- 将光标放在二元表达式中。
- 按 ⌘. (Windows, Linux Ctrl+.) 触发快速操作和重构菜单。
- 选择换行表达式以接受重构。