VS2019：创建模板文件，自定义代码片段

一、实现目的

1、新建一个cpp文件后，新的文件里有自动生成的代码，包括头文件，作者，实时的时间等

 

2、输入关键词后，自动弹出对应的代码片段，敲击“tab”可以插入片段，如：函数功能注释，swich语句等

 

 

二、实现过程

1、创建模板文件

（1）新建一个你想要的模板文件

 

（2）点击 ：项目--导出模板

 

（3）注意选择“项模板"，这是文件模板，第一个就变成整个项目的模板了

 

（4）选择刚才新建的文件，后面给它命名

 

（5）重启VS，再次新建文件时，就出现了刚才自己创建的模板

 

（6）删除模板

如果我们不想要这个模板了，需要删除，有三个地方需要清理

My Exported Templates

Templates下的两个文件夹

这三个地方的压缩包都需要清理干净

 

 

2、自定义代码片段

（1）在 vs2019 中依次选择 工具 --> 代码片段管理器 ，点击打开管理器窗口

选择 Visual C++（我现在使用的语言，操作方法对其他语言兼容），然后复制注释2中的地址并在文件资源管理器中定义到此地址，关闭代码片段管理器，资源管理器中的文件如下：

 

（2）现在开始编写自定义的代码片段。在这之前，可以用 notepad++ 查看这些.snippet代码片段的语法格式，然后通过复制 --> 粘贴 --> 重命名的方式创建新的代码片段（在这个文件目录中只能创建文件夹，无法重建文件）。现在通过这种方式，我创建了2个代码注释片段，名字依次为fnote.snippet，note.snippet。

fnote.snippet：函数功能注释，注明函数的数据、输入、输出以及简要说明。


<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets >
  <CodeSnippet Format="1.0.0">
    <Header>
      <Title>fnote</Title>
      <Shortcut>fnote</Shortcut>
	  <Description>function note</Description>
    </Header>
    <Snippet>
      <Code Language="cpp">
        <![CDATA[
///****************************************************************************
/// @data    :                                                                 
/// @input   :                                                                 
/// @output  :                                                                 
/// @brief   :                                                                 
///****************************************************************************
            ]]>
      </Code>
    </Snippet>
  </CodeSnippet>
</CodeSnippets>

 

note.snippet： 一般性说明代码片段


<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets >
  <CodeSnippet Format="1.0.0">
    <Header>
      <Title>gnote</Title>
      <Shortcut>gnote</Shortcut>
	  <Description>general note</Description>
    </Header>
    <Snippet>
      <Code Language="cpp">
        <![CDATA[
///****************************************************************************                 
/// @brief   :                                                                 
///****************************************************************************
            ]]>
      </Code>
    </Snippet>
  </CodeSnippet>
</CodeSnippets>

 

（3）在编写完自定义代码片段后，重启 visual studio 2019。点击工具 --> 代码片段管理验证新添加的代码片段，添加成功，如图：

 

 

三、参考资料

1、[C++VS2019中新建自定义模板与删除自定义模板_机械吴哥123的博客-CSDN博客]

2、[visual studio (2019) c/c++ 添加自定义代码片段+注释_飞天牛牛的博客-CSDN博客]