2.10. Rust プロジェクトのドキュメントのビルド


Cargo ツールを使用して、抽出用にマークされたソースコードのコメントからドキュメントを生成します。ドキュメントのコメントは、パブリック関数、変数、メンバーに対してのみ抽出されることに注意してください。

前提条件

手順

  • 抽出用のコメントをマークするには、3 つのスラッシュ /// を使用して、ドキュメント化された行頭にコメントを配置します。
    Cargo は、コメントのマークダウン言語をサポートしています。
  • Cargo を使用してプロジェクトのドキュメントをビルドするには、プロジェクトディレクトリーで実行します。

    • Red Hat Enterprise Linux 7 の場合

      $ scl enable rust-toolset-1.66 'cargo doc --no-deps'
      Copy to Clipboard Toggle word wrap
    • Red Hat Enterprise Linux 8 の場合

      $ cargo doc --no-deps
      Copy to Clipboard Toggle word wrap
    • Red Hat Enterprise Linux 9 の場合

      $ cargo doc --no-deps
      Copy to Clipboard Toggle word wrap

生成されたドキュメントは .target/doc ディレクトリーにあります。

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat