Comentários

Comentários explicam o código e são ignorados pelo compilador. Rust tem comentários comuns e comentários de documentação.

Comentário de linha

Começa com // e vai até o fim da linha.

fn main() {
    // Isto é um comentário
    let x = 5; // pode vir após o código
    println!("{}", x);
}

Comentário de bloco

Fica entre /* e */ e pode ocupar várias linhas.

fn main() {
    /*
      Este comentário
      tem várias linhas.
    */
    println!("Olá");
}

Comentário de documentação

Com /// você documenta itens (funções, structs). Esse texto vira documentação gerada pelo cargo doc.

/// Soma dois números inteiros.
///
/// # Exemplo
/// ```
/// let r = somar(2, 3);
/// assert_eq!(r, 5);
/// ```
fn somar(a: i32, b: i32) -> i32 {
    a + b
}

fn main() {
    println!("{}", somar(2, 3));
}

Boas práticas

• Explique o “porquê”, não o óbvio.
• Use /// para documentar a API pública.
• Mantenha comentários atualizados com o código.