مستندات

Rust دارای مستندات گسترده‌ای است. به عنوان مثال:

• تمام جزئیات مربوط به حلقه‌ها.
• تایپ‌های ابتدایی مانند u8.
• تایپ‌های کتابخانه استاندارد مانند Option یا BinaryHeap.

در واقع، شما می‌توانید کد خود را مستند کنید:

/// Determine whether the first argument is divisible by the second argument.
///
/// If the second argument is zero, the result is false.
fn is_divisible_by(lhs: u32, rhs: u32) -> bool {
    if rhs == 0 {
        return false;
    }
    lhs % rhs == 0
}

محتویات به‌عنوان Markdown پردازش می‌شوند. تمام crate‌های کتابخانه‌ای منتشرشده Rust به‌طور خودکار در docs.rs با استفاده از ابزار rustdoc مستند می‌شوند. مستند کردن تمام آیتم‌های عمومی در یک API با استفاده از این الگو به‌طور رایج مرسوم است.

برای مستند کردن یک آیتم از درون خود آیتم (مانند درون یک ماژول)، از !// یا /* .. !*/ استفاده کنید که به آن “کامنت‌های مستندات داخلی” می‌گویند:

//! This module contains functionality relating to divisibility of integers.