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

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

いずれかを使用：

=開始
この
です
a
コメント
ブロック
=終了

または

＃ この
＃は
＃a
＃コメント
＃ブロック

現在rdocでサポートされているのは2つだけなので、これだけを使用するのがよいと思います。

=begin
(some code here)
=end

そして

# This code
# on multiple lines
# is commented out

どちらも正しいです。最初のタイプのコメントの利点は編集可能性です。削除される文字が少ないため、コメントを外しやすくなります。2番目のタイプのコメントの利点は、読みやすさです。コードを1行ずつ読み取ると、特定の行がコメント化されていることを簡単に確認できます。あなたの電話ですが、あなたの後に来るのは誰か、そして彼らが読んで維持するのがどれほど簡単かについて考えてください。

次に例を示します。

=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

=begin comment line 1 comment line 2 =end = beginと= endがその行の最初のものであることを確認してください（スペースなし）

Ruby on Railsの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 %>

これは機能します。

  def idle
    <<~aid
    This is some description of what idle does.

    It does nothing actually, it's just here to show an example of multiline
    documentation. Thus said, this is something that is more common in the
    python community. That's an important point as it's good to also fit the
    expectation of your community of work. Now, if you agree with your team to
    go with a solution like this one for documenting your own base code, that's
    fine: just discuss about it with them first.

    Depending on your editor configuration, it won't be colored like a comment,
    like those starting with a "#". But as any keyword can be used for wrapping
    an heredoc, it is easy to spot anyway. One could even come with separated
    words for different puposes, so selective extraction for different types of
    documentation generation would be more practical. Depending on your editor,
    you possibly could configure it to use the same syntax highlight used for
    monoline comment when the keyword is one like aid or whatever you like.

    Also note that the squiggly-heredoc, using "~", allow to position
    the closing term with a level of indentation. That avoids to break the visual reading flow, unlike this far too long line.
    aid
  end

投稿の時点では、stackoverflowエンジンは構文の色付けを正しくレンダリングしないことに注意してください。選択したエディタでどのようにレンダリングされるかをテストすることは、演習として行います。;）