LabEx
EntrarJunte-se

Tipos de Comentários e Documentação em Rust

Beginner

This tutorial is from open-source community. Access the source code

Introdução

Neste laboratório, aprendemos sobre os diferentes tipos de comentários suportados pelo Rust, incluindo comentários regulares e comentários de documentação (doc comments). Comentários regulares podem ser comentários de linha, que começam com duas barras e vão até o final da linha, ou comentários de bloco, que são delimitados entre /* e */ e podem ser aninhados. Comentários de documentação (doc comments), por outro lado, são usados para gerar documentação HTML da biblioteca e começam com /// ou //!.

Nota: Se o laboratório não especificar um nome de arquivo, você pode usar qualquer nome de arquivo que desejar. Por exemplo, você pode usar main.rs, compilar e executá-lo com rustc main.rs && ./main.

Comentários

Qualquer programa requer comentários, e Rust suporta algumas variedades diferentes:

  • Comentários regulares que são ignorados pelo compilador:
    • // Comentários de linha que vão até o final da linha.
    • /* Comentários de bloco que vão até o delimitador de fechamento. */
  • Comentários de documentação (Doc comments) que são analisados em documentação HTML da biblioteca:
    • /// Gera documentação da biblioteca para o item seguinte.
    • //! Gera documentação da biblioteca para o item envolvente.
fn main() {
    // Este é um exemplo de um comentário de linha.
    // Existem duas barras no início da linha.
    // E nada escrito após estas será lido pelo compilador.

    // println!("Olá, mundo!");

    // Execute-o. Viu? Agora tente deletar as duas barras e execute-o novamente.

    /*
     * Este é outro tipo de comentário, um comentário de bloco. Em geral,
     * comentários de linha são o estilo de comentário recomendado. Mas comentários de bloco
     * são extremamente úteis para desabilitar temporariamente pedaços de código.
     * /* Comentários de bloco podem ser /* aninhados, */ */ então leva apenas algumas
     * teclas para comentar tudo nesta função main().
     * /*/*/* Tente você mesmo! */*/*/
     */

    /*
    Nota: A coluna anterior de `*` foi inteiramente por estilo. Não há
    nenhuma necessidade real disso.
    */

    // Você pode manipular expressões mais facilmente com comentários de bloco
    // do que com comentários de linha. Tente deletar os delimitadores de comentário
    // para alterar o resultado:
    let x = 5 + /* 90 + */ 5;
    println!("`x` é 10 ou 100? x = {}", x);
}

Resumo

Parabéns! Você concluiu o laboratório de Comentários. Você pode praticar mais laboratórios no LabEx para aprimorar suas habilidades.