A Linguagem de Programação Rust (PT-BR)

Comentários

Todo programador se esforça para tornar seu código fácil de entender, mas às vezes uma explicação extra é necessária. Nesses casos, programadores deixam comentários no código-fonte, que o compilador ignora, mas que podem ser úteis para quem estiver lendo o código.

Aqui está um comentário simples:

#![allow(unused)]
fn main() {
// hello, world
}

Em Rust, o estilo idiomático de comentário começa com duas barras, e o comentário continua até o fim da linha. Para comentários que ocupam mais de uma linha, você precisa incluir // em cada linha, assim:

#![allow(unused)]
fn main() {
// So we're doing something complicated here, long enough that we need
// multiple lines of comments to do it! Whew! Hopefully, this comment will
// explain what's going on.
}

Comentários também podem ser colocados ao final de linhas que contêm código:

Nome do arquivo: src/main.rs

fn main() {
    let lucky_number = 7; // I'm feeling lucky today
}

Mas com mais frequência você os verá neste formato, com o comentário em uma linha separada acima do código que ele está anotando:

Nome do arquivo: src/main.rs

fn main() {
    // I'm feeling lucky today
    let lucky_number = 7;
}

Rust também tem outro tipo de comentário, os comentários de documentação, que discutiremos na seção “Publicando uma crate no Crates.io” do Capítulo 14.