开发小技巧-Visual Studio项模板

上一篇文章开发小技巧-Visual Studio代码片段介绍了在Visual Studio中通过代码片段快速插入文本，对于需要包含特定内容的文件，除了使用代码片段来快速插入文本外，还可以通过项模板按照设定格式进行创建。本文根据Visual Studio 2022介绍创建及使用项模板的方法，其它版本可以参照进行设置。

项模板

微软MSDN中对项目和项模板的介绍如下：

项目和项目模板提供了可重用的存根，为用户提供了一些基本代码和结构，以供其根据自己的用途进行自定义。

在Visual Studio中创建或打开项目后，在菜单栏选择”项目”->”添加新项…”，在”添加新项”窗口中选择的即是一系列项模板，包括代码文件、XML 文件、HTML 页和样式表等。用户创建的模板实质上是打包好的.zip 文件。

制作模板文件

在项目中添加文件，根据所需内容进行修改。如，编写Template.cpp文件内容如下：

示例中使用了保留的模板参数：itemname（在其中使用参数的文件的名称）、username（当前的用户名称）、time（基于 Windows 用户设置的格式的当前时间。时间格式的一个示例为 DD/MM/YYYY 00:00:00）。

模板参数介绍可参考文章：项目和项模板参数 – Visual Studio (Windows) | Microsoft Docs[1]

导出模板

在VS菜单栏选择”项目”->”导出模板…”。

在”导出模板向导”的”选择模板类型”界面中选择”项模板”，点击”下一步”。

在”选择要导出的项”界面选择上一步制作的模板文件，点击”下一步”。

在”选择项引用”界面点击”下一步”。

在”选择模板选项”界面可以看到模板的输出位置及输出模板名称。在该界面设置模板名称、说明、图标及预览，勾选下方”自动将模板导入Visual Studio”，点击”完成”。

通过向导导出的模板默认位置是 %USERPROFILE%DocumentsVisual Studio <version>My Exported Templates，而VS加载模板的默认位置是 %USERPROFILE%DocumentsVisual Studio <version>TemplatesItemTemplates，因此若导出时未勾选”自动将模板导入Visual Studio”，则需要手动将模板复制到加载位置。

导出文件如下：

勾选”自动将模板导入Visual Studio”时，加载位置中也会包含一份相同的项模板文件：

使用模板新建项

导出模板或复制新模板到VS模板加载路径后，重启VS。创建或打开项目，在菜单栏选择”项目”->”添加新项…”或用快捷键”Ctrl+Shift+A”打开”添加新项”窗口。此时可以选择添加的模板，且右侧显示导出模板时编写的模板说明，如下：

添加该项后，自动创建文件如下：

模板文件可以手动进行修改，操作方法可参考文章更新现有项目项模板 – Visual Studio (Windows) | Microsoft Docs[2]

参考资料

[1]

项目和项模板参数 – Visual Studio (Windows) | Microsoft Docs: https://docs.microsoft.com/zh-cn/visualstudio/ide/template-parameters?view=vs-2022

[2]

更新现有项目项模板 – Visual Studio (Windows) | Microsoft Docs: https://docs.microsoft.com/zh-cn/visualstudio/ide/how-to-update-existing-templates?view=vs-2022

[3]

VS：创建项模板（新建文件后自动在其中添加代码） – 简书 (jianshu.com): https://www.jianshu.com/p/e070d0ae1e3c

[4]

用于项目和文件的模板 – Visual Studio (Windows) | Microsoft Docs: https://docs.microsoft.com/zh-cn/visualstudio/ide/creating-project-and-item-templates?view=vs-2022

[5]

创建项模板 – Visual Studio (Windows) | Microsoft Docs: https://docs.microsoft.com/zh-cn/visualstudio/ide/how-to-create-item-templates?view=vs-2022