comentário

Dica

Se você já estudou C, C++, Java ou C#, pode pular esta aula. O motivo é que os comentários do Rust funcionam quase igual a dessas linguagens.

O que é um comentário?

Texto explicativo feito para leitura humana, ele é ignorado pelo compilador e não interfere na execução do programa.

Quais são as funções dos comentários?

• Explicar a função do código: facilitar o entendimento para quem ler
• Registrar dados de autoria: utilizado para gerar arquivos de documentação
• Bloquear código temporariamente: manter trechos sem apagar, mas impedir que sejam executados com comentários
• Aumentar a legibilidade do código

As duas / três formas de comentário no Rust

• Comentário de linha: começa com // e vai até o final da linha
• Comentário de bloco: serve para comentar um trecho completo, pode ocupar várias linhas e é delimitado por /* ... */

Os comentários são como anotações que você faz em livros escolares, para ajudar a entender o conteúdo.

Vamos aprender os dois tipos mais comuns primeiro, depois veremos o terceiro depois.

fn main() {
    // O comentário de linha começa com duas barras e vai até o fim da linha.
    // Tudo depois das barras na mesma linha é ignorado pelo compilador.

    // Exemplo: essa linha de código não vai ser executada
    // println!("Hello, world!");

    // Tente remover as barras acima e rodar o código novamente.

    /*
     * O comentário de bloco é útil para desligar código temporariamente, veja abaixo
     * Ele também aceita aninhamento: /* assim */, para comentar blocos grandes rapidamente.
     */

    /*
     * println!("Hello, world!");
     * println!("Hello, world2!");
     */

    /*
    Observação: os asteriscos na coluna da esquerda são só para organizar visualmente,
    não são obrigatórios na sintaxe da linguagem e podem ser omitidos.
    */

    // Basta adicionar ou remover uma barra para ligar/desligar um bloco de comentário rapidamente:

    /* <- Adicione uma barra aqui para cancelar todo o bloco de comentário abaixo (coloque uma / antes do /* para virar //*, teste você mesmo)
    
    println!("Agora");
    println!("Todo");
    println!("o código vai rodar!");
    // Comentários de linha internos não são afetados

    // */

    // Comentários de bloco também podem ser colocados no meio de uma expressão:
    let x = 5 + /* 90 + */ 5;
    println!("O valor de `x` é 10 ou 100? x = {}", x);
}Code language: PHP (php)

Copie o código acima e teste por conta própria, especialmente a parte /* <- Adicione uma barra aqui para cancelar todo o bloco de comentário abaixo

(Explicação: adicionar uma / antes de /* forma //*, isso invalida o marcador de início do bloco, e o trecho // */ no final vira um comentário de linha.)

Isso funciona como se tivesse apagado o bloco de comentário temporariamente, e os comandos println no meio serão executados.

Comentários de documentação

Com os comentários de documentação é possível gerar arquivos HTML com ferramentas próprias, facilitando a consulta por desenvolvedores. Vamos estudar esse conteúdo em uma aula separada na sequência.