2.10. Rust プロジェクトのドキュメントのビルド
Cargo ツールを使用して、抽出用にマークされたソースコードのコメントからドキュメントを生成します。ドキュメントのコメントは、パブリック関数、変数、メンバーに対してのみ抽出されることに注意してください。
前提条件
手順
-
コードで、行頭にある 3 つのスラッシュ
///
を使用して、ドキュメントのコメントを抽出するために行にマークを付けます。 ドキュメントをビルドします。
cargo doc --no-deps
$ cargo doc --no-deps
Copy to Clipboard Copied! Toggle word wrap Toggle overflow このコマンドは、生成されたドキュメントを
.target/doc/
ディレクトリーに保存します。