如何在Ruby中注释多行?


当前回答

使用以下任一项:

=begin
This
is
a
comment
block
=end

or

# This
# is
# a
# comment
# block

是rdoc目前唯一支持的两个,我认为这是一个很好的理由只使用这些。

其他回答

=begin
My 
multiline
comment
here
=end

如果有人在RubyonRails中寻找在html模板中注释多行的方法,那么=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 %>

这会奏效的。

使用以下任一项:

=begin
This
is
a
comment
block
=end

or

# This
# is
# a
# comment
# block

是rdoc目前唯一支持的两个,我认为这是一个很好的理由只使用这些。

尽管存在=begin和=end,但正常且更正确的注释方式是在每行上使用#。如果您阅读任何ruby库的源代码,您会发现几乎在所有情况下都是这样进行多行注释的。

下面是一个示例:

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

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

=end

放置在=begin和=end之间的所有内容都将被视为注释,而不管其间包含多少行代码。

注意:确保=和begin之间没有空格:

正确:=开始错误:=开始