ドキュメント

Rust には豊富なドキュメントがあります。たとえば次のようなものです。

• ループ に関するすべての詳細。
• u8 のようなプリミティブ型。
• Option や BinaryHeap のような標準ライブラリの型。

ドキュメントを表示するには、rustup doc --std または https://std.rs を使用します。

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

// 著作権 2023 Google LLC
// SPDX-License-Identifier: Apache-2.0

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

内容は Markdown として扱われます。公開されているすべての Rust ライブラリ crate は、 rustdoc ツールを使って docs.rs で自動的にドキュメント化されます。こうしたパターンを使って API のすべての public な要素をドキュメント化するのが Rust らしい書き方です。

要素の内側（たとえばモジュールの内側）から要素をドキュメント化するには、//! または /*! .. */ を使います。これらは「内部ドキュメントコメント」と呼ばれます。

// 著作権 2023 Google LLC
// SPDX-License-Identifier: Apache-2.0

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