教程：创建项目模板

使用 .NET，可以创建和部署可生成项目、文件甚至资源的模板。 本教程是系列教程的第二部分，介绍如何创建、安装和卸载用于 dotnet new 命令的模板。

在本系列的这一部分中，你将了解如何：

创建项目模板的资源

创建模板配置文件夹和文件

从文件路径安装模板

测试项模板

卸载项模板

先决条件

完成本系列教程的第 1 部分。

打开终端并导航到 working\templates 文件夹。

创建项目模板

项目模板生成可立即运行的项目，使用户可以轻松地使用一组有效的代码。 .NET 包含一些项目模板，例如控制台应用程序或类库。 在本例中，你将创建一个启用 C# 10.0 并生成 async main 入口点的新控制台项目。

在终端中，导航到 working\templates 文件夹，并创建一个名为“consoleasync” 的新子文件夹。 进入子文件夹，并运行 dotnet new console 以生成标准控制台应用程序。 将编辑此模板生成的文件以创建新模板。

working

└───templates

└───consoleasync

consoleasync.csproj

Program.cs

修改 Program.cs

打开 program.cs 文件。 控制台项目不使用异步入口点，我们来添加它。 将代码更改为以下内容并保存文件。

await Console.Out.WriteAsync("Hello World with C# 10.0!");

修改 consoleasync.csproj

将项目使用的 C# 语言版本更新到 10.0 版。 编辑 consoleasync.csproj 文件并将 <LangVersion> 设置添加到<PropertyGroup> 节点。

<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>

<OutputType>Exe</OutputType>

<TargetFramework>net6.0</TargetFramework>

<LangVersion>10.0</LangVersion>

</PropertyGroup>

</Project>

生成项目

在完成项目模板之前，应对其进行测试，确保它能够正确编译和运行。

在终端中，运行以下命令。

dotnet run

将获得以下输出。

Hello World with C# 10.0!

可以使用 dotnet run 删除已创建的 obj 和 bin 文件夹。 删除这些文件可确保你的模板仅包含与模板相关的文件，而不包含生成操作产生的任何文件。

现在你已经创建了模板的内容，需要在模板的根文件夹中创建模板配置。

创建模板配置

模板在 .NET 中通过模板根目录中的特殊文件夹和配置文件进行识别。 在本教程中，你的模板文件夹位于 working\templates\consoleasync 。

创建模板时，除特殊配置文件夹外，模板文件夹中的所有文件和文件夹都作为模板的一部分包含在内。 此配置文件夹名为“.template.config” 。

首先，创建一个名为“.template.config” 的新子文件夹，然后进入该文件夹。 然后，创建一个名为“template.json” 的新文件。 文件夹结构应如下所示。

working

└───templates

└───consoleasync

└───.template.config

template.json

使用你喜爱的文本编辑器打开 template.json 并粘贴以下 json 代码，然后保存。

{

"