文档

Rust comes with extensive documentation. For example:

• All of the details about loops.
• 'u8' 等基元类型。
• Standard library types like Option or 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
}

The contents are treated as Markdown. All published Rust library crates are automatically documented at docs.rs using the rustdoc tool. It is idiomatic to document all public items in an API using this pattern.

如需从项内（例如在模块内）为项编写文档，请使用 //! 或 /*! .. */，这称为“内部文档注释”：

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