使用Try.NET创建可交互.NET文档

来自:LamondLu的博客英文原文

背景


当我们编写开发人员使用的文档时,我们需要捕捉他们的兴趣,并引导他们尽快走上成功的道路。开发人员生态系统一直在为社区提供可交互的文档,用户可以一个地方阅读文档,运行代码并进行编辑。


在过去的2年里,.NET语言团队一直在不断发展Try .NET, 以支持在线和离线的交互式文档。


什么是Try .NET


Try .NET是一个基于.NET Core的交互式文档生成器。




控制台标签页: *WASM Initialized*



网络标签页: DLLs



Try .NET提供了全局工具dotnet try, 以方便.NET开发人员创建可交互的Markdown文件。


为了使你的Markdown文件具有交互性,你需要安装.NET Core的SDK, 全局工具dotnet try, 以及Visual Studio / VS Code。




``` cs 
var name ="Rain";
Console.WriteLine($"Hello {name.ToUpper()}!");
```


使用Try .NET, 我们可以扩展隔离代码块,给它添加一些额外的参数。


``` cs --region methods --source-file .\myapp\Program.cs --project .\myapp\myapp.csproj 
var name ="Rain";
Console.WriteLine($"Hello {name.ToUpper()}!");
```



使用


在Markdown中,我们扩展了代码块,提供了--region参数,用它可以指定C代码中的分块(region)。


所以,你的Program.cs文件看起来可能是这样的。


using System;
namespace HelloWorld
{
   class Program
   {
       static void Main(string[] args)
       
{
           region methods
           var name ="Rain"
           Console.WriteLine($"Hello{name.ToUpper()}!");  
           endregion
       }
   }
}



尝试使用全局工具dotnet try


dotnet try现在已经可以使用了。这是一个dotnet try全局工具的早期预览版,你可以从我们的仓储克隆代码。


入门


  • 克隆代码仓储


  • 签出Samples分支


  • 安装.NET Core 2.1或3.0预览版


  • 打开控制台窗口


  • 安装Try .NET全局工具


dotnet tool install --global dotnet-try --version 1.0.19264.11


更新dotnet try也很简单,只需要运行如下命令


dotnet tool update -g dotnet-try


定位到当前仓储的Samples目录,输入dotnet try



浏览器会自动打开



推荐↓↓↓
DotNet程序员
上一篇:Dapper的正确使用姿势 下一篇:.NET Core一行代码导入导出Excel生成Word