VSIX 项目模板入门

  • 项目

可以使用 VSIX 项目模板创建扩展或打包现有扩展以供部署。 VSIX 项目模板同时具有 Visual Basic 和 Visual C# 版本，并作为 Visual Studio SDK 的一部分安装。

VSIX 项目模板仅包含一个 source.extension.vsixmanifest 文件，其中包含有关扩展及其附带的资产的信息。

若要查找 VSIX 项目模板，必须安装 Visual Studio SDK。 有关详细信息，请参阅 Visual Studio SDK。

使用 VSIX 项目模板部署自定义项目模板

以下步骤演示如何使用 VSIX 项目打包可与其他开发人员共享或上传到 Visual Studio 库的项目模板。

  1. 创建项目模板。

    1. 打开从中创建模板的项目。 此项目可以是任何项目类型。

    2. 在“项目”菜单上，单击“导出模板”。 完成向导的步骤。

      .zip文件是在 . 中创建的%USERPROFILE%\My Documents\Visual Studio {version}\My Exported Templates\。

  2. 创建空的 VSIX 项目。

    选择“文件”>“新建”>“项目”。 在搜索框中，键入“vsix”，然后选择 VSIX 项目的 C# 或 Visual Basic 版本。

  3. 将 .zip 文件添加到项目。 将其 “复制到输出目录 ”属性设置为 Copy Always。

  4. 在 解决方案资源管理器 中，双击 source.extension.vsixmanifest 文件以在 VSIX 清单设计器中打开该文件，然后进行以下更改：

    • 将“产品名称”字段设置为“我的项目模板”。

    • 将 “产品 ID ”字段设置为 MyProjectTemplate - 1。

    • 将“作者”字段设置为 Fabrikam。

    • 将“说明”字段设置为“我的项目”模板。

    • 在“资产”部分中，添加 Microsoft.VisualStudio.ProjectTemplate 类型，并将其路径设置为.zip文件的名称。

  5. 保存并关闭 source.extension.vsixmanifest 文件。

  6. 生成项目。

  7. 在输出目录中，双击 .vsix 该文件。

  8. 此时会显示 VSIX 安装程序消息框。 按照说明安装扩展。

  9. 关闭 Visual Studio，然后重新打开它。

  10. 选择“管理扩展”（在“扩展”菜单上），然后选择“模板”类别。 其中一个可用扩展应该是 “我的项目模板”。

  11. 新项目模板与 原始项目模板位于同一位置的“新建项目 ”对话框中。 例如，如果从 Visual Basic 控制台应用程序创建了名为 VB 控制台 的模板， VB 控制台 将显示在与 Visual Basic 控制台应用程序 模板相同的窗格中。

在“新建项目”对话框中指定模板的位置

  1. 模板文件夹位于 {Visual Studio Installation Path}\Common7\IDE\ProjectTemplates 目录和 {Visual Studio Installation Path}\Common7\IDE\ItemTemplates 目录中。 “ 新建项目 ”对话框中顶级节的名称与模板文件夹的名称不完全匹配。 如果它们不同，请使用模板文件夹的名称。

    将 .vsix 文件扩展名更改为 .zip，然后打开该文件。

  2. 创建一个与“新建项目”对话框的分区同名的新文件夹，模板应出现在其中。

  3. 如果模板显示在子节中，请创建同名的子文件夹。

  4. 将模板 .zip 文件移动到新文件夹中。

  5. 将 .zip 扩展更改为 .vsix.

  6. 打开 VSIX 清单。

  7. 在 VSIX 清单中，更新模板的资产路径，使其指向包含模板文件的目录树的根目录。 例如，如果模板位于该模板中 \CSharp\Windows，则引用应指向 \CSharp。