Comentarios de varias líneas en Ruby?

¿Cómo puedo comentar varias líneas en Ruby?

#!/usr/bin/env ruby

=begin
Every body mentioned this way
to have multiline comments.

The =begin and =end must be at the beginning of the line or
it will be a syntax error.
=end

puts "Hello world!"

<<-DOC
Also, you could create a docstring.
which...
DOC

puts "Hello world!"

"..is kinda ugly and creates
a String instance, but I know one guy
with a Smalltalk background, who
does this."

puts "Hello world!"

##
# most
# people
# do
# this


__END__

But all forgot there is another option.
Only at the end of a file, of course.

• Así es como se ve (a través de la captura de pantalla); de lo contrario, es difícil interpretar cómo se verán los comentarios anteriores. Haga clic para acercar :

=begin
My 
multiline
comment
here
=end

A pesar de la existencia de =beginy =end, la forma normal y más correcta de comentar es usar #'s en cada línea. Si lee la fuente de cualquier biblioteca de ruby, verá que esta es la forma en que se hacen comentarios de varias líneas en casi todos los casos.

#!/usr/bin/env ruby

=begin
Between =begin and =end, any number
of lines may be written. All of these
lines are ignored by the Ruby interpreter.
=end

puts "Hello world!"

Usando:

= comenzar
Esta
es
una
comentario
bloquear
= fin

o

# Esta
# es
# una
# comentario
# bloque

son los dos únicos actualmente soportados por rdoc, lo cual es una buena razón para usar solo estos, creo.

=begin
(some code here)
=end

y

# This code
# on multiple lines
# is commented out

Son ambos correctos. La ventaja del primer tipo de comentario es la editabilidad: es más fácil descomentar porque se eliminan menos caracteres. La ventaja del segundo tipo de comentario es la legibilidad: al leer el código línea por línea, es mucho más fácil saber que una línea en particular ha sido comentada. Tu llamada, pero piensa en quién vendrá después de ti y qué tan fácil es para ellos leer y mantener.

Aquí hay un ejemplo :

=begin 
print "Give me a number:"
number = gets.chomp.to_f

total = number * 10
puts  "The total value is : #{total}"

=end

Todo lo que coloques en el medio =beginy =endserá tratado como un comentario, independientemente de cuántas líneas de código contenga.

Nota: Asegúrese de que no haya espacio entre =y begin:

• Correcto: =begin
• Incorrecto: = begin

=begin comment line 1 comment line 2 =end asegúrese de que = begin y = end es lo primero en esa línea (sin espacios)

En caso de que alguien esté buscando una manera de comentar varias líneas en una plantilla html en Ruby on Rails, podría haber un problema con = begin = end, por ejemplo:

<%
=begin
%>
  ... multiple HTML lines to comment out
  <%= image_tag("image.jpg") %>
<%
=end
%>

fallará debido a que%> cierra la etiqueta_imagen.

En este caso, tal vez sea discutible si esto está comentando o no, pero prefiero encerrar la sección no deseada con un bloque "si es falso":

<% if false %>
  ... multiple HTML lines to comment out
  <%= image_tag("image.jpg") %>
<% end %>

Esto funcionará

  def idle
    <<~aid
    This is some description of what idle does.

    It does nothing actually, it's just here to show an example of multiline
    documentation. Thus said, this is something that is more common in the
    python community. That's an important point as it's good to also fit the
    expectation of your community of work. Now, if you agree with your team to
    go with a solution like this one for documenting your own base code, that's
    fine: just discuss about it with them first.

    Depending on your editor configuration, it won't be colored like a comment,
    like those starting with a "#". But as any keyword can be used for wrapping
    an heredoc, it is easy to spot anyway. One could even come with separated
    words for different puposes, so selective extraction for different types of
    documentation generation would be more practical. Depending on your editor,
    you possibly could configure it to use the same syntax highlight used for
    monoline comment when the keyword is one like aid or whatever you like.

    Also note that the squiggly-heredoc, using "~", allow to position
    the closing term with a level of indentation. That avoids to break the visual reading flow, unlike this far too long line.
    aid
  end

Tenga en cuenta que en el momento de la publicación, el motor de stackoverflow no representa la coloración de sintaxis correctamente. Probar cómo se muestra en el editor de su elección se deja como un ejercicio. ;)