Ruby - Comentarios

Los comentarios son líneas de anotación dentro del código Ruby que se ignoran en tiempo de ejecución. Un comentario de una sola línea comienza con el carácter # y se extiende desde el # hasta el final de la línea de la siguiente manera:

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

puts "Hello, Ruby!"

Cuando se ejecuta, el programa anterior produce el siguiente resultado:

Hello, Ruby!

Comentarios de Ruby Multiline

Puede comentar varias líneas usando =begin y =end sintaxis de la siguiente manera:

#!/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

Cuando se ejecuta, el programa anterior produce el siguiente resultado:

Hello, Ruby!

Asegúrese de que los comentarios finales estén lo suficientemente lejos del código y que se distingan fácilmente. Si existe más de un comentario final en un bloque, alinéelos. Por ejemplo

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