Tài liệu

Rust đi kèm với một bộ tài liệu rất chi tiết. Ví dụ:

• Tất cả chi tiết về vòng lặp.
• Các kiểu dữ liệu cơ bản như u8.
• Các kiểu dữ liệu thuộc về thư viện chuẩn như Option hoặc BinaryHeap.

Ngoài ra, bạn cũng có thể tự viết tài liệu cho code của bản thân:

/// Xác định xem tham số thứ nhất có chia hết cho tham số thứ hai không.
///
/// Nếu tham số thứ hai bằng không, trả về kết quả là sai.
fn is_divisible_by(lhs: u32, rhs: u32) -> bool {
    if rhs == 0 {
        return false;
    }
    lhs % rhs == 0
}

Nội dung tài liệu sẽ được xử lý bằng Markdown. Tất cả các thư viện Rust đã được publish đều sẽ tự động được công cụ rustdoc viết tài liệu, và được lưu trữ tại docs.rs. Tất cả thành phần công khai trong một API nên được viết tài liệu theo phương pháp này.

Để viết tài liệu cho một thành phần từ bên trong thành phần đó (như bên trong một module), hãy sử dụng //! hoặc /*! .. */. Cú pháp trên thường được gọi là “inner doc comments”:

//! Module này chứa các chức năng liên quan đến việc kiểm tra quan hệ chia hết của các số nguyên.