ruby - comentarios en programacion
Comentarios multilĂnea en rubĂ? (9)
¿Cómo puedo comentar varias líneas en Ruby?
A pesar de la existencia de =begin
y =end
, la forma normal y más correcta de comentar es usar #
''en cada línea. Si lees la fuente de cualquier biblioteca de Ruby, verás que esta es la forma en que se realizan los comentarios de varias líneas en casi todos los casos.
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 coloque entre =begin
y =end
se tratará como un comentario, independientemente de la cantidad de líneas de código que contenga.
Nota: asegúrese de que no haya espacio entre =
y begin
:
- Correcto:
=begin
- Incorrecto:
= begin
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 image_tag.
En este caso, tal vez sea discutible si esto es comentar 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á.
Utilizando cualquiera de
=begin This is a comment block =end
o
# This # is # a # comment # block
son los únicos dos actualmente soportados por rdoc, lo cual es una buena razón para usar solo estos, creo.
=begin comment line 1 comment line 2 =end
asegurarte = comenzar y = finalizar es lo primero en esa línea (sin espacios)
#!/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!"
#!/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.
=begin
(some code here)
=end
y
# This code
# on multiple lines
# is commented out
ambos son correctos La ventaja del primer tipo de comentario es la capacidad de edición: es más fácil descomprimirlo porque se eliminan menos caracteres. La ventaja del segundo tipo de comentario es la legibilidad: leer el código línea por línea, es mucho más fácil decir que una línea en particular ha sido comentada. Su llamada, pero piense en quién está detrás de usted y lo fácil que es para ellos leer y mantener.
=begin
My
multiline
comment
here
=end