2.10. Rust プロジェクトのドキュメントのビルド
Cargo ツールを使用して、抽出用にマークされたソースコードのコメントからドキュメントを生成します。ドキュメントのコメントは、パブリック関数、変数、メンバーに対してのみ抽出されることに注意してください。
前提条件
-
ビルド済みの Rust プロジェクトがある。
Rust プロジェクトのビルド方法は、Rust プロジェクトのビルド を参照してください。 -
設定された依存関係がある。
依存関係の設定に関する詳細は、Rust プロジェクト依存関係の設定 を参照してください。
手順
-
抽出用のコメントをマークするには、3 つのスラッシュ
///を使用して、ドキュメント化された行頭にコメントを配置します。
Cargo は、コメントのマークダウン言語をサポートしています。 Cargo を使用してプロジェクトのドキュメントをビルドするには、プロジェクトディレクトリーで実行します。
Red Hat Enterprise Linux 8 の場合
$ cargo doc --no-deps
Red Hat Enterprise Linux 9 の場合
$ cargo doc --no-deps
生成されたドキュメントは .target/doc ディレクトリーにあります。
関連情報
- Cargo を使用したドキュメントのビルドに関する詳細は、The Rust Programming Language — Making Useful Documentation Comments を参照してください。
