Try .NET 项目教程

1. 项目介绍

Try .NET 是一个由微软开发的工具，旨在为开发者和内容创作者提供创建交互式体验的工具。该项目主要有两个不同的交互式体验：

• Web 体验：由 Blazor 驱动，用户可以在浏览器中运行和编辑代码，常见于 Microsoft Learn 等平台。
• 交互式文档：使用 dotnet try 全局工具，开发者可以创建交互式的 .NET Core 文档，用户可以在本地或在线环境中运行和编辑代码。

2. 项目快速启动

安装 .NET Core SDK

首先，确保你已经安装了 .NET Core 3.0 SDK 或更高版本。你可以从 .NET 官方网站 下载并安装。

安装 dotnet try 全局工具

使用以下命令安装 dotnet try 全局工具：

dotnet tool install -g dotnet-try

创建交互式文档

1. 创建一个新的目录，并在该目录中初始化一个新的 .NET 项目：

   mkdir my-interactive-docs
   cd my-interactive-docs
   dotnet new console
   

2. 在该目录中创建一个 Markdown 文件，例如 README.md，并在文件中添加以下内容：

   # 我的交互式文档
   
   ```csharp
   // 这是一个简单的 C# 代码示例
   using System;
   
   namespace HelloWorld
   {
       class Program
       {
           static void Main(string[] args)
           {
               Console.WriteLine("Hello, World!");
           }
       }
   }
   

3. 使用 dotnet try 启动交互式文档：

   dotnet try
   

   这将启动一个本地服务器，并在浏览器中打开交互式文档。

3. 应用案例和最佳实践

应用案例

• Microsoft Learn：Microsoft Learn 使用 Try .NET 创建交互式文档，用户可以在浏览器中运行和编辑 .NET 代码。
• NCache Live：NCache Live 使用 Try .NET 让用户在浏览器中体验 NCache API，通过可执行和可编辑的 .NET 代码。

最佳实践

• 代码示例：在文档中包含详细的代码示例，帮助用户理解如何使用 API 或功能。
• 交互式体验：确保文档中的代码是可运行的，用户可以直接在浏览器中尝试和修改代码。
• 版本控制：使用版本控制系统（如 Git）管理文档和代码，确保文档的更新和维护。

4. 典型生态项目

• Blazor：Try .NET 的 Web 体验由 Blazor 驱动，Blazor 是一个用于构建交互式 Web 应用程序的 .NET 框架。
• .NET Core SDK：Try .NET 依赖于 .NET Core SDK，确保你安装了正确的 SDK 版本。
• Visual Studio Code：虽然不是必需的，但 Visual Studio Code 是一个流行的代码编辑器，支持 .NET 开发，并提供了丰富的扩展和插件。

通过以上步骤，你可以快速上手并开始使用 Try .NET 创建交互式文档和体验。