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

Rust постачається з обширною документацією. Наприклад:

• Всі подробиці про цикли.
• Примітивні типи на зразок u8
• Типи стандартної бібліотеки, такі як Option або BinaryHeap.

Використовуйте rustup doc --std або https://std.rs для перегляду документації.

Фактично, ви можете документувати свій власний код:

/// Визначити, чи ділиться перший аргумент на другий.
///
/// Якщо другий аргумент дорівнює нулю, результат буде false.
fn is_divisible_by(lhs: u32, rhs: u32) -> bool {
    if rhs == 0 {
        return false;
    }
    lhs % rhs == 0
}

Контент розглядається як Markdown. Усі опубліковані крейти бібліотеки Rust автоматично документуються на docs.rs за допомогою rustdoc. Це ідіоматично документувати всі публічні елементи в API за допомогою цього шаблону.

Щоб задокументувати елемент із середини елемента (наприклад, всередині модуля), використовуйте //! або /*! .. */, які називаються “внутрішні коментарі до документу”:

//! Цей модуль містить функціональність, пов'язану з подільністю цілих чисел.