开发小技巧-Visual Studio代码片段【二】

前面在开发小技巧-Visual Studio代码片段中介绍了如何通过代码片段来快速插入文本（基于Visual Studio 2022），本文主要对代码片段相关内容进行补充介绍。

插入代码片段

Visual Studio 中有两种类型的代码片段：扩展代码片段和外侧代码片段，前者在指定的插入点添加，并且可以替换代码片段快捷方式，后者仅限 C# 和 C++，在所选代码块的周围添加。

代码片段 – Visual Studio (Windows)^[1]中提到了扩展代码片段和外侧代码片段两种代码片段，扩展代码片段可以通过输入代码片段快捷方式按Tab键补全或使用”Ctrl+K,Ctrl+X”快捷键快速插入，而外侧代码片段使用”Ctrl+K,Ctrl+S”快捷键插入。

由于外侧代码片段在所选代码块的周围添加，因此可以在选中代码块后按下”Ctrl+K,Ctrl+S”快捷键以使用代码片段来包围所选代码。

代码片段对象替换

一些代码片段中包含需要用户替换的对象。如，在代码中插入for代码片段，其中的size_t、i、length处于高亮状态，size_t默认被选中，用户可以使用Tab键在各个对象间切换并修改，修改完成按下回车键光标会自动跳转到for循环中。

代码片段中的关键字和插入完成时的光标位置在代码片段文件中定义，如，for代码片段文件（for.snippet）内容如下：

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
 <CodeSnippet Format="1.0.0">
  <Header>
   <Title>for</Title>
   <Shortcut>for</Shortcut>
   <Description>for 循环的代码片段</Description>
   <Author>Microsoft Corporation</Author>
   <SnippetTypes>
    <SnippetType>Expansion</SnippetType>
    <SnippetType>SurroundsWith</SnippetType>
   </SnippetTypes>
  </Header>
  <Snippet>
   <Declarations>
    <Literal>
     <ID>type</ID>
     <Default>size_t</Default>
     <ToolTip>控制变量类型</ToolTip>
    </Literal>
    <Literal>
     <ID>index</ID>
     <Default>i</Default>
     <ToolTip>索引</ToolTip>
    </Literal>
    <Literal>
     <ID>max</ID>
     <Default>length</Default>
     <ToolTip>最大长度</ToolTip>
    </Literal>
   </Declarations>
   <Code Language="cpp"><![CDATA[for ($type$ $index$ = 0; $index$ < $max$; $index$++)
  {
   $selected$ $end$
  }]]>
   </Code>
  </Snippet>
 </CodeSnippet>
</CodeSnippets>

代码片段文件中，Snippet元素内的Code子元素定义了代码片段包含的代码，此处即for语句。for语句中使用$声明了3个关键字type、index、max，这些关键字在Declarations元素的Literal子元素中定义，如关键字type的默认值为size_t，提示为控制变量类型。

<Literal>
    <ID>type</ID>
    <Default>size_t</Default>
    <ToolTip>控制变量类型</ToolTip>
</Literal>

当插入代码片段时，片段中的关键字会替换为Literal元素中设置的默认值并高亮显示。

另外代码片段中还有两个保留关键字 $end$ 和 $selected$ ， $end$ 用于标记代码片段插入完成时的光标位置， $selected$ 主要用于外侧代码片段，在插入代码片段时会替换为用户已选中的文本。

参考资料

[1]

代码片段 – Visual Studio (Windows) | Microsoft Docs: https://docs.microsoft.com/zh-cn/visualstudio/ide/code-snippets?view=vs-2022

[2]

Visual C++ 代码片段 – Visual Studio (Windows) | Microsoft Learn: https://learn.microsoft.com/zh-cn/visualstudio/ide/visual-cpp-code-snippets?view=vs-2022

[3]

代码片段架构参考 – Visual Studio (Windows) | Microsoft Learn: https://learn.microsoft.com/zh-cn/visualstudio/ide/code-snippets-schema-reference?view=vs-2022