Looking for rust Answers? Try Ask4KnowledgeBase
Looking for rust Keywords? Try Ask4Keywords

Rustドキュメンテーション


前書き

Rustのコンパイラには、プロジェクトを素早く簡単に文書化するための便利な機能がいくつかあります。コンパイラlintを使用して、各関数のドキュメントを実施し、サンプルにテストを組み込むことができます。

構文

  • ///外部の文書コメント(下記の項目に適用)

  • //!内部文書のコメント(囲む項目に適用)

  • cargo doc#このライブラリクレートのドキュメントを生成します。

  • cargo doc --open#このライブラリの箱とオープンブラウザのドキュメントを生成します。

  • cargo doc -p CRATE#指定されたクレートの文書のみを生成します。

  • cargo doc --no-deps#このライブラリのドキュメントを生成します。依存関係はありません。

  • cargo test#ユニットテストとドキュメンテーションテストを実行します。

備考

「Rust Book」のこのセクションには、ドキュメンテーションとドキュメンテーションのテストに関する有益な情報が含まれている場合があります。

ドキュメンテーションのコメントは次のものに適用できます。

  • モジュール
  • 構造
  • 列挙型
  • メソッド
  • 関数
  • 形質と形質の方法

ドキュメンテーション 関連する例