Documentación

Rust incluye una amplia documentación. Por ejemplo:

• Todos los detalles sobre bucles.
• Tipos primitivos como u8.
• Tipos de la biblioteca estándar como Option o BinaryHeap.

De hecho, puedes documentar tu propio código:

/// Determina si el primer argumento es divisible por el segundo argumento.
///
/// Si el segundo es cero, el resultado será false.
fn is_divisible_by(lhs: u32, rhs: u32) -> bool {
    if rhs == 0 {
        return false;
    }
    lhs % rhs == 0
}

El contenido se trata como Markdown. Todos los crates de la biblioteca de Rust publicados se documentan automáticamente en docs.rs mediante la herramienta rustdoc. Es propio documentar todos los elementos públicos de una API usando este patrón.

Para documentar un elemento desde dentro (por ejemplo, dentro de un módulo), utiliza //! o /*! .. */, denominado como "comentarios internos del documento":

//! Este módulo contiene funciones relacionadas con la divisibilidad de números enteros.