rustdoc-library-documentation

Rustdoc ライブラリドキュメント

このスキルを使うと、Rust ライブラリのドキュメントを実行可能で、ナビゲートしやすく、下流のクレート利用者にとって役立つものにできます。

基本的なワークフロー

1. 内部モジュールの順序ではなく、利用者が最初に行うタスクから始めます。
2. クレートレベルおよびモジュールレベルのドキュメントを追加して、目的と境界を説明します。
3. 公開型、関数、エラー、機能、不変条件をドキュメント化します。
4. コア API には、短くコンパイル可能な例や doctest を優先します。
5. より長いシナリオは examples/ に配置し、ドキュメントから参照します。
6. 公開前にドキュメントと doctest を実行します。

次に読む項目

タスク	読み込むもの
公開クレート API をドキュメント化する	guidelines.md、workflows/document-library.md
doctest または例を追加する	references/rustdoc-patterns.md
公開に向けてドキュメントを準備する	references/rustdoc-patterns.md

出典について

このガイダンスは、Herbert Wolverson 著『Advanced Hands-On Rust』、特にライブラリのドキュメント化を扱う第 4 章と、クレートの共有を扱う第 15 章をもとに、翻案および要約したものです。例は独自の雛形です。