Ruby - comentários

Comentários são linhas de anotação no código Ruby que são ignoradas no tempo de execução. Um comentário de uma única linha começa com o caractere # e se estende de # até o final da linha da seguinte forma -

#!/usr/bin/ruby -w
# This is a single line comment.

puts "Hello, Ruby!"

Quando executado, o programa acima produz o seguinte resultado -

Hello, Ruby!

Comentários Ruby Multiline

Você pode comentar várias linhas usando =begin e =end sintaxe da seguinte forma -

#!/usr/bin/ruby -w

puts "Hello, Ruby!"

=begin
This is a multiline comment and con spwan as many lines as you
like. But =begin and =end should come in the first line only. 
=end

Quando executado, o programa acima produz o seguinte resultado -

Hello, Ruby!

Certifique-se de que os comentários finais estejam distantes o suficiente do código e que sejam facilmente distinguidos. Se houver mais de um comentário final em um bloco, alinhe-os. Por exemplo -

@counter      # keeps track times page has been hit
@siteCounter  # keeps track of times all pages have been hit