Ruby中的多行注释?

我如何评论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. 
 =begin My multiline comment here =end 

尽pipe=begin=end的存在,正常和更正确的评论方式是在每一行使用# 。 如果你读过任何ruby库的源代码,你会发现这是几乎所有情况下多行注释的方式。

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

使用:

 =开始
这个
是
一个
评论
块
 =端

要么

 # 这个
 #是
 # 一个
 #评论
 #块

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

 =begin (some code here) =end 

 # This code # on multiple lines # is commented out 

都是正确的。 第一种评论的优点是可编辑性 – 取消评论更容易,因为更less的字符被删除。 第二类评论的优点是可读性 – 逐行阅读代码,很容易判断某一行是否已被注释掉。 你的电话,但要考虑到谁来,以及他们阅读和维护是多么容易。

这里是一个例子:

 =begin print "Give me a number:" number = gets.chomp.to_f total = number * 10 puts "The total value is : #{total}" =end 

你放在=begin=end之间的所有东西都将被视为注释,而不pipe它包含多less行代码。

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

  • 正确: =begin
  • 错: = begin