Rust言語のライブラリのソースコードをリポジトリで公開する際、慣例的にexamplesというディレクトリが用意されていることが多いです。
このexamplesの配下にはライブラリの使い方を示すサンプルコードが置かれており、初めてそのライブラリを触るユーザーをガイドするという重要な役割を果たしています。
この記事ではより良い例の書き方について、私が意識していることを3つ紹介します。
先に伝えたいことだけまとめると、コードは最小構成にし、ユーザーが段階を踏んで例を確認できるような構成にしましょう。
simple.rsを用意する
これ地味に重要です。
simple.rsは初めて使うユーザ…
Source link
Views: 2
