# Inserindo comentários no Ruby
Ruby 3/10/07 às 12:30Um recurso básico oferecido pela imensa maioria das linguagens de programação, se não por todas, é a capacidade de inserir texto descritivo no código fonte, de forma a explicar certos detalhes sobre o código, ou até mesmo o seu propósito como um todo. Este tipo de texto, que obviamente é ignorado pelo compilador/interpretador, é chamado de comentário, e está disponível também no Ruby.
Para inserir comentários no Ruby, basta escrevê-los logo após o caractere #. Uma vez que o interpretador do Ruby encontrar este caractere, ele irá ignorar tudo o que vier em seguida, mas somente até o fim da linha atual. Sendo assim, este caractere só serve para comentários de uma única linha. Para escrever comentários mais extensos, você terá que prefixar cada linha do comentário com o caractere #. Veja abaixo alguns exemplos de comentários no Ruby:
# Variável que armazena a minha idade
idade = 22
puts idade # Exibindo a minha idade
# Estes comentários são para exemplificar a sintaxe dos
# comentários no Ruby, tendo inclusive comentários
# de mais de uma linha, como esse, por exemplo
No código acima, o interpretador do Ruby só irá executar a instrução que atribui o valor 22 à variável idade, e a instrução que exibe o valor desta variável. Todo o resto será ignorado, uma vez que está após o caractere #.
Há ainda uma sintaxe alternativa para inserir comentários de mais de uma linha. Para usá-la, basta iniciar o bloco de comentários com =begin e terminá-lo com =end. Dessa forma, o interpretador do Ruby irá ignorar tudo que estiver entre =begin e =end. Veja abaixo um exemplo desse tipo de comentário:
=begin
Esta é a sintaxe alternativa para comentários de múltiplas linhas
Como podem ver, seu uso também é bastante simples
=end
Um detalhe que deve ser observado no uso desse tipo de comentário é que o =begin e =end devem estar exatamente no começo da linha. Caso haja pelo menos um caractere antes dele, mesmo que seja o caractere de espaço, o Ruby irá gerar um erro.
Por fim, é válido mencionar também que esse último tipo de comentário não é tão usado. Em geral, os comentários prefixados por # são mais usados, mesmo em comentários de múltiplas linhas.

[...] o post sobre comentários no Ruby, me veio à mente um assunto bastante recorrente no desenvolvimento de software: o uso correto dos [...]
Valeu essa dica!
=begin
…
=end
ainda não tinha “descoberto” isso.
abraço!
Olá, tatiC.
Confesso que até recentemente também não conhecia essa sintaxe alternativa para comentários de múltiplas linhas. Até porque, pelo que eu observei, não é muita usada na prática.