Comentários de ferrugem

Os comentários são um recurso incrivelmente útil que permite que os desenvolvedores incluam documentação curta, mas descritiva, em um programa.

A capacidade de adicionar comentários ao seu código pode ajudar a melhorar a legibilidade para você e outros desenvolvedores que possam ler e usar seu código.

Como funcionam os comentários?

Comentários não são nada de especial. Eles são apenas um conjunto de caracteres de texto que descrevem como ou o que um pedaço de código está fazendo.

O comentário usa caracteres especiais que fazem o compilador ignorá -los. Vamos discutir como podemos implementar e usar comentários em nossos programas.

Comentários de ferrugem

Existem três tipos de comentários em Rust:

1. Comentários simples ou de linha
2. Bloqueie comentários
3. Comentários do documento

Vamos discutir.

Comentários simples de linha

Comentários simples ou de linha são o tipo de comentário que abrange uma única linha. Eles são usados ​​principalmente para inserir uma mensagem curta e descritiva em um bloco de código.

Em Rust, podemos inserir comentários de linha única usando caracteres de barra dupla para frente. Um exemplo é como mostrado:

fn main ()
// comentário de linha única
println!("Olá Mundo!");

Como mencionado, um comentário de linha única abrange uma única linha. Conforme mostrado no exemplo, o compilador de abovethe ignora a linha depois de 8 os dois caracteres de slash para a frente.

Bloqueie comentários

O segundo tipo de comentário é conhecido como comentários de bloco. Estes são intimamente semelhantes a simples

STTART Ao abrir o bloco de comentários com um personagem de slash para frente e um asterisco, como (/*).

Depois disso, podemos adicionar o texto do comentário e fechar o bloco de comentários com um asterisco e reação como (*/).

Um exemplo de comentário em bloco na ferrugem é como mostrado:

fn main ()
/*
um comentário em bloco
vãos
linhas mutliple
*/
println!("Olá Mundo!");

O código acima mostra a criação de um comentário de bloco que abrange várias linhas.

Comentários do documento

Rust também nos fornece comentários de documentos. Existem dois tipos principais de comentários do documento em Rust:

1. Comentários do DOC interno
2. Comentários de documentos externos.

Comentários do DOC interno

Os comentários internos do DOC são denotados por uma barra dupla e um bang como //!. Eles estão escritos dentro de um bloco de código são usados ​​principalmente para gerar documentação para um código dentro de um bloco especificado.

Um exemplo é como mostrado:

fn main ()
//! documentação
println!("Olá Mundo!");

O código acima indica um comentário do documento interno.

Comentário externo do documento

Como o nome sugere, um comentário externo do documento refere -se a um comentário em torno de um bloco externo de código e atuando como documentação para esse bloco.

Os comentários externos do DOC são indicados por barras triplas para a frente. Um exemplo é mostrado:

/// função principal
///
fn main ()
println!("Olá Mundo!");

Conclusão

Este artigo ajuda a entender vários tipos de comentários em ferrugem e como criar mensagens curtas e descritivas para seus blocos de código.

Esperamos que você tenha gostado do artigo, obrigado!