ドキュメント
Rust には詳細なドキュメントが用意されています。次に例を示します。
- All of the details about loops.
u8
のようなプリミティブ型。Option
やBinaryHeap
などの標準ライブラリ型。
Use rustup doc --std
or https://std.rs to view the documentation.
実際、独自のコードにドキュメントをつけることができます。
コンテンツはマークダウンとして扱われます。公開されたすべての Rust ライブラリ クレートは、rustdoc ツールを使用して、docs.rs
で自動的にドキュメントがまとめられます。このパターンを使用して、すべての公開アイテムを API でドキュメント化するのが慣用的です。
アイテム内(モジュール内など)からアイテムをドキュメント化するには、「内部ドキュメントのコメント」と呼ばれる //!
または /*! .. */
を使用します。
Speaker Notes
This slide should take about 5 minutes.
- https://docs.rs/rand で
rand
クレート用に生成されたドキュメントを受講者に示します。