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

最近需要在代码中添加注释和文件头，每次都手动敲或者复制不太方便，查了一下发现在Visual Studio中可以通过代码片段来快速插入文本。本文根据Visual Studio 2022介绍添加代码片段的方法，其它版本可以参照进行设置。

代码片段

微软MSDN中对代码片段的介绍如下：

代码片段是小块可重用代码，可通过右键单击菜单（关联菜单）命令或热键组合插入到代码文件中。代码片段通常包含常用的代码块（如 try-finally 或 if-else 块），可用于插入整个类或方法。

使用起来发现代码片段其实是VS代码自动补全的一部分。比如，在源文件中输入enum关键字，VS会提示补全内容，此处的enum实际就是一份代码片段，按下Tab键即可自动补全enum声明。

查看代码片段

在VS菜单栏选择”工具”->”代码片段管理器”，或用快捷键”Ctrl+K,Ctrl+B”打开代码片段管理器窗口。

在语言下拉框中选择使用的语言，这里选择”Visual C++”。

窗口左侧的树视图中展示代码片段文件夹和所有的代码片段。

其中，”位置”路径栏指示树视图中选中项的路径。”Visual C++”为默认代码片段文件夹，包含VC++的一些默认代码片段，如”enum”、”switch”、”while”等。”My Code Snippets”为自定义代码片段文件夹，也可以通过下方的”添加”和”移除”按钮设置其它文件夹。”导入”按钮用于添加代码片段。

每份代码片段用一份xml格式的.snippet文件定义，在树视图中选中代码片段后可以在路径栏看到对应的.snippet文件完整路径，树视图右侧会显示该代码片段的信息，包括”说明”、”快捷方式”（触发自动补全的快捷字符）、”片段类型”、”作者”。

如，enum代码片段信息如下：

自定义代码片段

代码片段可以参考默认的.snippet文件进行编写。如，enum.snippet文件内容如下：

.snippet文件中根元素是 <CodeSnippets>，其中包含<CodeSnippet>子元素。<CodeSnippet>元素中包含<Header>和<Snippet>两个子元素，<Header>元素中记录了代码片段管理器中展示的信息，<Snippet>元素中记录代码片段的内容。

此处<Snippet>元素中的<Declarations>子元素包含enum的声明信息，默认的枚举名为”MyEnum”。<Code>子元素具有Language属性，其中CDATA 部分内为完整的代码片段。

创建自定义代码片段时可以直接复制一份.snippet文件进行修改，也可以新建一份xml文件按照相同模板编写。

如，下面创建了一份文件名为cpp_header.snippet的文件头代码片段：

<?xml version="1.0" encoding="utf-8"?><CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">  <CodeSnippet Format="1.0.0">    <Header>      <Title>cppheader</Title>      <Shortcut>cppheader</Shortcut>      <Description>.cpp文件头片段</Description>      <Author>Javier</Author>      <SnippetTypes>        <SnippetType>Expansion</SnippetType>      </SnippetTypes>    </Header>    <Snippet>      <Code Language="cpp"><![CDATA[/** * @file  Class.cpp * @brief  Description * @author  Javier * @date  2022-03-30 */]]>      </Code>    </Snippet>  </CodeSnippet></CodeSnippets>

代码片段的片段类型与代码片段插入方式相关，分为扩展（Expansion）代码片段和外侧（SurroundsWith）代码片段。扩展代码片段在指定的插入点添加，并且可以替换代码片段快捷方式。外侧代码片段（仅限C#和C++）在选定代码块周围添加。详细介绍可以查看代码片段 – Visual Studio (Windows)[1]文章的”扩展式代码片段和外侧代码片段”部分进行了解。

创建代码片段可以参考创建代码片段 – Visual Studio (Windows)[2]文章。

添加代码片段

添加代码片段有两种方法。

一种是直接将.snippet文件复制到代码片段文件夹中，重新打开代码片段管理器即可看到新添加的代码片段。

如，将cpp_header.snippet复制到默认的My Code Snippets文件夹中，此时再打开代码片段管理器展开My Code Snippets即可看到cppheader代码片段。

另一种方法是使用代码片段管理器的”导入”按钮将文件导入到指定文件夹：

点击代码片段管理器的”导入”按钮
在代码片段目录中选择.snippet文件，点击”打开”
在导入代码片段向导中选中代码片段，选择导入位置，点击”完成”添加代码片段

使用”导入”按钮导入将会复制一份.snippet文件到指定位置。一次可以选择多个.snippet文件，并支持分别设置导入位置。

使用代码片段

VS中提供了多种方式插入代码片段，最简单的方式是输入代码片段快捷方式按Tab键补全：

如上即插入了默认的文件头，再手动修改特定内容即可。代码注释块也可以用相同方式添加代码片段并插入。

另外也可以右键选择”片段”插入代码片段，或直接使用快捷键”Ctrl+K,Ctrl+X”插入。

参考资料

[1]

visual studio (2019) c/c++ 添加自定义代码片段+注释: https://blog.csdn.net/weixin_37834269/article/details/107042242

[2]

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

[3]

演练：创建代码片段 – Visual Studio (Windows) | Microsoft Docs: https://docs.microsoft.com/zh-cn/visualstudio/ide/walkthrough-creating-a-code-snippet?view=vs-2022