ドキュメント

Rust には詳細なドキュメントが用意されています。次に例を示します。

• All of the details about loops.
• u8 のようなプリミティブ型。
• Option や BinaryHeap などの標準ライブラリ型。

Use rustup doc --std or https://std.rs to view the documentation.

実際、独自のコードにドキュメントをつけることができます。

/// 最初の引数が 2 番目の引数で割り切れるかどうかを判定します。
///
/// 2 番目の引数がゼロの場合、結果は false になります。
fn is_divisible_by(lhs: u32, rhs: u32) -> bool {
    if rhs == 0 {
        return false;
    }
    lhs % rhs == 0
}

コンテンツはマークダウンとして扱われます。公開されたすべての Rust ライブラリ クレートは、rustdoc ツールを使用して、docs.rs で自動的にドキュメントがまとめられます。このパターンを使用して、すべての公開アイテムを API でドキュメント化するのが慣用的です。

アイテム内（モジュール内など）からアイテムをドキュメント化するには、「内部ドキュメントのコメント」と呼ばれる //! または /*! .. */ を使用します。

//! このモジュールには、整数の整除に関連する機能が含まれています。