rustdoc を使用すると、各行の上に doc コメントを含めることで、構造体フィールドと列挙バリアントを文書化できます。

これらは、rustdoc によって生成された HTML に適切な書式で表示されます。しかし、私は、関数の引数に対して適切にフォーマットされた同様のドキュメントを作成する方法を見たことがありません。それらを文書化する「公式の」方法はありますか、それとも関数のメインのドキュメントセクションで自由形式で説明する必要がありますか?

Rust のドキュメンテーション コメントの例をテストするための優れたツール rustdoc (現在cargoで使用) があります。rdoc や yard は、Ruby で同様のものを提供しますか?

私のプログラムが依存しているライブラリの錆のドキュメントを見たいです。これらをどのように引き下げることができますか？標準ライブラリの回答に関する質問を見つけましたが、具体的には crates.io の依存関係を探しています。

ライブラリのドキュメント サンプル内のエラーを修正するのに苦労しています。クレートのようなファイル構造を持っていますbignum

私の例では、ヘッダーは次のようになります

これはコンパイルして問題なく動作しますが、 のドキュメント内に例を書いているときに、lib.rsインポートできないようですbignum::inits::Zero

を実行するcargo testと、このエラーが表示されます

この質問を見たことがありますが、これは同じファイルからモジュールをインポートすることを扱っていますが、それでもトップレベルのスコープが必要です。ただし、ここではまだトップレベルのスコープを で指定していbignum::ます。

そのため、インポートbignum::inits::Zeroはすべてのテストと例で機能しますが、ドキュメントでは機能しません。何故ですか？前に追加しようとしましself::たが、同じエラーが発生します。ドキュメントの例を次のように変更すると

ただし、正常にコンパイルされます。モジュールを正しくインポートするにはどうすればよいですか?

Rust で書いているプロジェクトのドキュメントを書こうとしています。ドキュメントの 1 つは、を使用する必要がありregex::Regexます。これが私が書こうとしているドキュメントです：

それは私にこのエラーを与えます:

しかし、追加するextern crate regex;と、次のエラーが発生します。

関連ファイルの関連部分は次のとおりです。

ソース/lib.rs:

ソース/トークン化/mod.rs:

(上) src/tokenize/util.rs:

プロジェクトのレイアウトで何が間違っていますか?

Rust 1.6.0 の時点で、生成されたドキュメントは各マクロ パターンの実装を非表示にします。

Cargo で生成されたドキュメントから一部のパターンを非表示にする方法はありますか?