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