创建项模板

2025-06-21

本文介绍如何使用 导出模板向导 或手动创建项模板，以及如何编辑和使用项模板。如果模板包含多个文件，另请参阅如何：创建多文件项模板。

添加项模板

在 Visual Studio 中创建或打开项目。
选择 Project>Add New Item 或按 Ctrl+Shift+A。
在 Add New Item 对话框中，选择一个项，然后选择 Add 将其添加到项目中。
根据需要修改项，并指示应在项中的位置（如果任何位置）进行参数替换。有关详细信息，请参阅 “如何：替换模板中的参数”。
保存项目。
选择 Project>Export Template。此时会打开 “导出模板向导 ”。
在 Choose Template Type （选择模板类型 ）页面上，选择 Item Template （项目模板），选择包含该项目的项目，然后选择 Next （下一步）。
在 Select Item To Export （选择要导出的项目 ）页面上，选择要为其创建模板的项目，然后选择 Next （下一步）。
在 Select Item References 页面上，选择要包含在模板中的任何程序集引用，然后选择 Next。
在 Select Template Options 页面上：
- 输入模板名称和可选描述、图标图像和预览图像。
  
  项的图标文件是 .ico 文件，如 Visual Studio 的图像和图标中所述。预览图像是显示在“ 添加新项 ”对话框中的 200 x 200 图像。您可以下载 Visual Studio 图像库以获取与 Visual Studio 样式一致的图标。
- 选择是否 自动将模板导入 Visual Studio 并在 output files 文件夹中显示资源管理器窗口。
选择完成。

模板文件将压缩为 .zip 文件，并复制到向导中 Output ___location （输出位置）下显示的目录中。默认位置为 %USERPROFILE%\Documents\Visual Studio <version>\My Exported Templates。

如果选择了 Automatically import the template into Visual Studio， 则.zip 文件也会添加到用户 ItemTemplates 目录中。默认位置为 %USERPROFILE%\Documents\Visual Studio <version>\Templates\ItemTemplates。

现在，您可以在项目中使用项模板。

使用项模板

如果您在创建模板时没有选择 Automatically import the template into Visual Studio ，请将 .zip 文件复制到您的 ItemTemplates 目录。默认位置为 %USERPROFILE%\Documents\Visual Studio <version>\Templates\ItemTemplates。
关闭 Visual Studio，然后重新打开它。
创建新项目，或打开现有项目，然后选择 Project>Add New Item
从 Add New Item 对话框中选择项模板。如果您在 Export Template Wizard 中添加了描述，则该描述将显示在对话框的右侧。
选择 Add （添加 ）以将模板项添加到您的项目中。

编辑 .vstemplate 文件

向导将创建一个基本模板，但在某些情况下，您需要在导出模板后手动修改 .vstemplate 文件。例如，如果希望该项显示在通用 Windows 应用程序项目的 “添加新项 ”对话框中，则必须编辑 .vstemplate 文件。

将导出的项模板 .zip 文件中提取出来，然后在 Visual Studio 中打开 .vstemplate 文件。
根据需要编辑文件。对于 C# 通用 Windows 项目，请在元素内部<TemplateData>添加<TemplateID>Microsoft.CSharp.Class</TemplateID>。
保存并关闭 .vstemplate 文件，然后将其替换为 .zip 文件。

为特定工程子类型启用模板

您可以编辑 .vstemplate 文件以指定仅对某些工程子类型（如 Windows、Office、Database 或 Web）显示项模板。

打开 .vstemplate 文件进行编辑。
在元素之后ProjectType立即添加一个 ProjectSubType 元素，其值为 Windows、、 DatabaseOffice或 Web。例如： <ProjectSubType>Database</ProjectSubType>。

以下示例显示了项目的 .vstemplate 文件 Office 。

<VSTemplate Version="2.0.0" Type="Item" Version="2.0.0">
   <TemplateData>
      <Name>Class</Name>
      <Description>An empty class file</Description>
      <Icon>Class.ico</Icon>
      <ProjectType>CSharp</ProjectType>
      <ProjectSubType>Office</ProjectSubType>
      <DefaultName>Class.cs</DefaultName>
   </TemplateData>
   <TemplateContent>
      <ProjectItem>Class1.cs</ProjectItem>
   </TemplateContent>
</VSTemplate>

手动创建项模板

您可以从头开始手动创建项模板，而不是使用向导。

创建工程并添加项目。
根据需要修改项目，例如添加应进行任何参数替换的位置，然后保存该项目。
创建一个 XML 文件，并使用 .vstemplate 文件扩展名将其保存在与项目项文件相同的目录中。
将项模板元数据添加到 .vstemplate XML 文件，如前面的示例所示。有关更多信息，请参阅模板架构参考（可扩展性）。
保存并关闭 .vstemplate 文件。
在 Windows 资源管理器中，选择要包含在模板中的文件，包括 .vstemplate 文件。右键单击所选内容，然后选择“ 压缩到>ZIP 文件”。
复制生成的 .zip 文件并将其粘贴到 Visual Studio 用户项模板位置。默认目录为 %USERPROFILE%\Documents\Visual Studio <version>\Templates\ItemTemplates。

通过