🐥note.

小鳥とMicrosoft <3 なエンジニアの技術Blog📚

dotnet tryによるC#のInteractive Documentの作り方

dotnet tryをご存じでしょうか?
Microsoft製のC#用Interactive Documentation Generator(Markdown内に書いたC#のコードをその場で実行・結果確認できる資料)です。

C#なのにjupyter notebookっぽい(?)使い方ができそうな感じで、講義用の資料を作るのに重宝しそうなToolです。

本エントリではdotnet tryの紹介と、dotnet tryで作られたC# 8.0の新機能の説明資料などをご紹介を致します。

デモ

f:id:piyo_esq:20191005160242g:plain
dotnet try デモ

こんな感じに動作します。

dotnet tryのインストール

github.com

こちらに記載されている通りです。

環境

dotnet-tryのインストールには以下が必要です。

環境構築手順

.NET Core 3.0をインストール後、以下のコマンドでdotnet-tryをインストールできます。

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

既にインストール済みの方は以下のコマンドでアップデートしてください。

dotnet tool update -g dotnet-try

以上で完了です。

使ってみる

任意の空のディレクトリで以下のコマンドを実行します。

dotnet try demo

こんな感じのページが表示されたら成功です。

f:id:piyo_esq:20191005160356p:plain
Quick Start画面

コードが記述されている箇所の右上の再生ボタンを押下するとプログラムが実行されます。

f:id:piyo_esq:20191005160428p:plain
コード実行後画面

自分でdocumentを作ってみる

自分でdocumentを書いてみましょう。

mkdir tryDocument
cd tryDocument
dotnet new console -o trySample

以下の内容のreadme.mdを作成します。
※readme.mdが起動時のindexページ相当になるようです。

# My Interactive Document:  

\```cs --source-file ./trySample/Program.cs --project ./trySample/trySample.csproj  
\```

※```の先頭の\を外すこと

編集後dotnet tryで起動します。

f:id:piyo_esq:20191005160512p:plain
Hello Interactive Document!

ばっちりですね。

おまけ:MicrosoftC# 8.0の新機能紹介資料

MicrosoftC# 8.0の新機能の紹介資料をdotnet-try用に作ってくれています。

こちらのレポジトリのcsharp8です。

github.com

git clone https://github.com/dotnet/try-samples.git
cd try-samples
cd csharp8
dotnet try

お~

f:id:piyo_esq:20191005160612p:plain
C# 8.0の機能紹介

ほかにもC# 7.0からC# 7.3の機能や、LINQの紹介、C#初心者向けの入門資料なども同封されているようです。

おわり

資料で説明しつつコードを実行できるという点が講義解説教育用途にマッチしていますね。

dotnet-tryのインストールが不要でポータブルに実行できるになればもっと便利になりそうですね…。

以上です。