Como comentar em Ruby

Em um ponto ou de outro, todo desenvolvedor se encontra em uma situação em que precisam modificar o código -fonte de um script. Sem documentação e informação adequadas para guiá -lo, isso se torna quase impossível. É aí que o conceito de comentar seu código entra em jogo.

Comentários são simplesmente informações adicionadas ao código -fonte de um programa para fins de documentação. Interpretadores e compiladores de idiomas ignoram comentários. Embora o principal uso dos comentários seja documentar e descrever as operações de um bloco de código, elas podem ser convenientes ao depurar seu código.

Neste tutorial, aprenderemos várias maneiras de comentar o código em scripts de rubi.

Uso básico: comentários de linha única

Existem vários tipos de comentários em Ruby. No entanto, o mais básico é um comentário de linha única.

Começa com um símbolo de libra (#) e continua até o final da linha.

# Ruby Comentário de linha única
Imprima "Olá de Ruby!"

Como você pode ver no exemplo acima, o comentário de linha única começa com o símbolo da libra e se estende até o final da linha.

O intérprete de rubi ignora o texto dentro do comentário de linha única, mesmo que carregue código rubi válido.

Um comentário de linha única em Ruby pode começar no início de uma linha ou final, como mostrado abaixo:

Imprima "Olá de Ruby!" # Ruby Comentário de linha única

Nesse caso, o conteúdo antes do sinal de libra (#) é contado como código rubi válido enquanto o conteúdo após isso não é.

Comentários de bloco/multi-line

Em outros casos, você precisa descrever o que o código faz de maneira mais detalhada. Para incluir comentários que abrangem várias linhas em Ruby, implementamos comentários em bloco.

Existem duas maneiras de implementar comentários em bloco em Ruby:

1: = BEGIN/= END

Este método usa o = BEGIN e = Formato Final para incluir as linhas dentro do bloco como comentários.

Aqui está um exemplo:

= Comece
Este é um comentário
que abrange várias linhas
e é muito útil para documentação detalhada
= fim
Imprima "Hi Block Comments!"

Nesse tipo de comentário, começamos usando a palavra -chave = BEGN, seguida por todas as linhas que desejamos comentar e fechar com = fim.

O uso deste formato de comentário é raro porque não oferece muita flexibilidade na formatação dos comentários, e é muito ilegível.

2: Múltiplos símbolos de libra (#)

A maneira mais comum de comentar várias linhas em Ruby é pré-aceitar cada linha com um sinal de libra.

Aqui está um exemplo:

# Este é outro método de comentário
# que abrange várias linhas
# e é muito útil para documentação detalhada

Nesse caso, temos várias linhas comentadas. Usando editores modernos, você pode destacar um bloco de código e comentar de uma só vez.

Comentários e comentários mágicos

Ruby é uma linguagem interessante porque oferece comentários mágicos. Comentários mágicos fazem um formato semelhante aos comentários regulares, mas em vez de serem ignorados pelo intérprete, eles mudam o comportamento do intérprete.

Comentários mágicos contêm diretivas de rubi que definem o que modificar sobre o intérprete.

O exemplo abaixo mostra um comentário mágico para modificar a codificação para literais de string.

# codificação: UTF-8

Embora o exposto acima pareça um comentário regular, ele contém uma diretiva reconhecida pelo rubi.

Para saber mais sobre as diretivas de comentários mágicos, considere a documentação dos comentários do rubi.

Resumo

Este guia rápido discutiu vários tipos de comentários de rubi, incluindo como implementá -los com facilidade.