Многострочные комментарии в Ruby?

Ответ 1

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

Ответ 2

=begin
My 
multiline
comment
here
=end

Ответ 3

Несмотря на существование =begin и =end, нормальный и более правильный способ комментариев - использовать # для каждой строки. Если вы прочитаете источник любой библиотеки ruby, вы увидите, что это так, как многострочные комментарии выполняются почти во всех случаях.

Ответ 4

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

Ответ 5

Используя либо:

=begin
This
is
a
comment
block
=end

или

# This
# is
# a
# comment
# block

являются единственными, которые в настоящее время поддерживаются rdoc, что является хорошей причиной для использования только этих я думаю.

Ответ 6

=begin
(some code here)
=end

и

# This code
# on multiple lines
# is commented out

оба правильны. Преимущество первого типа комментариев - редактируемость - его легче раскомментировать, поскольку меньше символов удаляется. Преимущество второго типа комментариев - читаемость и чтение кода за строкой, гораздо проще сказать, что определенная строка была прокомментирована. Ваш звонок, но подумайте о том, кто идет за вами и как легко им читать и поддерживать.

Ответ 7

Вот пример:

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

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

=end

Все, что вы размещаете между =begin и =end, будет рассматриваться как комментарий, независимо от того, сколько строк кода оно содержит.

Примечание. Убедитесь, что между = и begin нет пробела:

• Правильно: =begin
• Неверно: = begin