Документация

В Rust есть обширная документация. Например:

• Все подробности о циклах.
• Примитивные типы, например u8.
• Типы стандартной библиотеки, например Option или BinaryHeap.

Чтобы просмотреть документацию, используйте rustup doc --std или https://std.rs.

На самом деле вы можете документировать и собственный код:

// Copyright 2023 Google LLC
// SPDX-License-Identifier: Apache-2.0

/// Определяет, делится ли первый аргумент на второй.
///
/// Если второй аргумент равен нулю, результат --- false.
fn is_divisible_by(lhs: u32, rhs: u32) -> bool {
    if rhs == 0 {
        return false;
    }
    lhs % rhs == 0
}

Содержимое интерпретируется как Markdown. Все опубликованные крейты библиотек Rust автоматически документируются на docs.rs с помощью инструмента rustdoc. Документировать таким образом все общедоступные элементы API — идиоматичный подход.

Чтобы задокументировать элемент изнутри него (например, внутри модуля), используйте //! или /*! .. */, так называемые «внутренние doc-комментарии»:

// Copyright 2023 Google LLC
// SPDX-License-Identifier: Apache-2.0

//! Этот модуль содержит функции, связанные с делимостью целых чисел.