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

Question

Как прокомментировать несколько строк в Ruby?

Answer 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.

• Вот так это выглядит (через скриншот) - иначе сложно интерпретировать, как будут выглядеть вышеупомянутые комментарии. Нажмите, чтобы увеличить :

Answer 2

=begin
My 
multiline
comment
here
=end

Answer 3

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

Answer 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!"

Answer 5

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

=begin
This
is
a
comment
block
=end

или

# This
# is
# a
# comment
# block

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

Answer 6

=begin
(some code here)
=end

и

# This code
# on multiple lines
# is commented out

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

Answer 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

Answer 8

=begin comment line 1 comment line 2 =end убедитесь, что = начало и = конец - первое, что есть в этой строке (без пробелов)

Answer 9

Если кто-то ищет способ комментировать несколько строк в шаблоне html в Ruby on Rails, может возникнуть проблема с = begin = end, например:

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

не удастся, потому что%> закрывающий image_tag.

В этом случае, возможно, можно поспорить, комментирует это или нет, но я предпочитаю заключать нежелательный раздел в блок «if false»:

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

Это будет работать.