32

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

enum Choices {
  /// The first choice.
  First,
  /// The second choice.
  Second,
}

struct Person {
  /// The person's name.
  name: String,
  /// The person's age.
  age: u8,
}

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

4

3 に答える 3

30

いくつかの例で次のスタイルが使用されているのを見てきました。

/// Brief.
///
/// Description.
/// 
/// * `foo` - Text about foo.
/// * `bar` - Text about bar.
fn function (foo: i32, bar: &str) {}

これまでのところ、私にとってもうまくいっています。

PSこれにも問題があります。PS 1.48 で
の改善されたrustdocリンクと検索エイリアス も確認してください。

于 2015-05-03T11:01:09.540 に答える