Dokümantasyon

Rust, kapsamlı bir dokümantasyonla birlikte gelir. Örneğin:

• Döngüler hakkındaki tüm ayrıntılar.
• u8 gibi ilkel türler (primitive types).
• Option veya BinaryHeap gibi standart kütüphane türleri.

Dokümantasyonu görüntülemek için rustup doc --std veya https://std.rs kullanın.

Aslında, kendi kodunuzu belgeleyebilirsiniz:

/// İlk argümanın ikinci argümana bölünüp bölünemeyeceğini belirle.
///
/// İkinci argüman sıfır ise, sonuç yanlıştır.
fn is_divisible_by(lhs: u32, rhs: u32) -> bool {
    if rhs == 0 {
        return false;
    }
    lhs % rhs == 0
}

İçerikler Markdown olarak işlenir. Yayınlanan tüm Rust kütüphane kasaları (crates), rustdoc aracı kullanılarak docs.rs adresinde otomatik olarak belgelenir. Bir API’deki tüm genel (public) öğeleri bu deseni kullanarak belgelemek, tercih edilen yaklaşımdır (idiomatic).

Bir öğeyi, öğenin içinden (bir modülün içi gibi) belgelemek için “iç doküman yorumları (inner doc comments)” olarak adlandırılan //! veya /*! .. */ kullanın:

//! Bu modül, tamsayıların bölünebilirliği ile ilgili fonksiyonellik içerir.