语言

在 Visual Studio 中使用代码片段

代码片段是可添加到代码文件的可重用代码的小块。 代码片段通常包含常用构造,例如 Try...FinallyIf...Else 块。 还可以使用代码片段添加整个类或方法。

代码片段有一个标题,你可以通过它来选取该代码片段;它还可以有一个快捷方式,你可以通过输入该快捷方式来插入它。 代码片段还可以包含替换参数,这些参数充当占位符。 Visual Studio为多种语言(包括 C#、C++ 和 Visual Basic)提供代码片段。

先决条件

  • 已安装了对你要使用的编程语言的支持的 Visual Studio。 可用的代码片段取决于已安装的工作负载和语言组件。
  • 在编辑器中打开代码文件,并由相应的语言服务识别。 对于 C++ 示例,请打开 .cpp.h 文件。

了解代码段类型

Visual Studio支持两种类型的代码片段:

  • 扩展片段在指定的插入点添加代码。
  • 环绕式代码片段会在所选代码的周围添加代码。 环绕代码片段仅适用于 C# 和 C++ 。

查找可用的代码片段

若要查看语言的已安装代码片段,请选择 “工具>代码片段管理器 ”或按 Ctrl+K、Ctrl+B。 在 代码片段管理器中,从 语言列表中选择一 种语言。

若要创建和导入自己的代码片段,使其显示在代码片段列表中,请参阅 “演练:在 Visual Studio 中创建代码片段”。

Note

键盘快捷方式可能因设置配置文件、上下文、键盘布局和自定义键绑定而异。 若要查找命令的绑定,请参阅 “标识并自定义键盘快捷方式”。

插入扩展片段

扩展片段在插入点插入代码。 例如,C# tryf 代码片段添加一个 try/finally 块:

try
{

}
finally
{

}

您必须在语句有效的位置插入 tryf 代码片段,例如在方法、索引器、属性访问器或事件访问器内部。

  1. 在代码编辑器中,将光标置于要添加代码片段的位置。

  2. 请执行以下一项操作:

    • 在菜单栏上,选择 “编辑>IntelliSense>插入代码段”。
    • 右键单击并选择 “代码段>插入代码段”。
    • Ctrl+K、Ctrl+X
  3. 在代码片段选取器中,打开 Visual C# 文件夹,然后双击 tryf。 还可以选择 tryf ,然后按 TabEnter

try / finally 块会出现在插入点处,可供您自定义。

小窍门

在有效的插入点,键入 tryf,然后按 Tab 两次以展开代码片段,而无需打开代码段选取器。

用代码片段包围所选代码

环绕代码片段会将所选代码包裹起来。 例如,C++ if 代码片段将所选行 return FALSE; 包裹在 if 块中:

if (true)
{
    return FALSE;
}

若要将选定的 C++ 代码括起来:

  1. .cpp.h 文件中,选择要包裹的代码。

  2. 请执行以下一项操作:

    • 在菜单栏上,依次选择“编辑>IntelliSense>环绕”。
    • 右键单击并选择“环绕”
  3. 在代码片段选取器中,双击 if,或者选择 是否TabEnter

if 显示在所选代码周围。 将 true 占位符替换为要计算的条件。

有关更多 C++ 代码片段示例,请参阅 Visual C++ 代码片段

编辑替换字段

代码段可以包含插入后自定义的替换字段。 当同一字段多次出现时,更改一个匹配项将更改所有链接匹配项。 按 Tab 移动到下一个替换字段。

例如,Visual Basic定义属性代码段包含支持变量、属性名称和属性类型的链接字段。 若要插入它,请执行以下操作:

  1. 在Visual Basic代码文件中,右键单击要插入属性的位置,然后选择“代码段>插入代码段”。
  2. 选择 代码模式>属性、过程、事件>定义属性

Visual Basic 代码片段选择器的截图,其中在“属性”、“过程”、“事件”下选中了“定义属性”。

插入以下代码:

Private newPropertyValue As String
Public Property NewProperty() As String
    Get
        Return newPropertyValue
    End Get
    Set(ByVal value As String)
        newPropertyValue = value
    End Set
End Property

如果将 newPropertyValue 更改为 m_property,则每个已链接的 newPropertyValue 实例都会更改。 如果将属性类型从 String 更改为 Integer,则每个已链接的 String 实例都会变为 Integer

代码片段问题排查

如果代码片段或命令不可用:

  • 确认Visual Studio将文件识别为预期的编程语言。
  • 确认已安装所需的工作负荷或语言组件。
  • “工具>代码片段管理器”中,确认为所选语言安装了代码段。
  • 如果键盘快捷方式无法按预期工作,请使用 “识别”和自定义键盘快捷方式 来查找命令的当前绑定。
  • 检查插入点是否对所选代码段有效。 例如,某些 C# 代码片段仅在方法或类型声明中有效。 有关有效的 C# 插入位置,请参阅 C# 代码片段

查看由代码片段插入的代码

代码片段代码显示了执行任务的基本方法。 在应用程序中使用它之前,请查看并调整生成的代码。 请考虑代码如何处理异常、访问资源、验证输入和保护机密。

像对待从 Internet 下载的代码一样对待从 Internet 下载的代码片段。 仅从信任的源下载代码片段,并在导入或运行代码之前检查代码段代码和元数据。

在 .NET Framework 项目中,代码片段可以使用References元素添加项目引用。 检查 ImportsReferences 元素,并确认你信任所引用的程序集。 有关详细信息,请参阅 导入命名空间代码片段架构参考

另见