860 Stimmen

Mehrzeilige Kommentare in Ruby?

Wie kann ich mehrere Zeilen in Ruby kommentieren?

9 Stimmen

Es ist ziemlich unglücklich, dass mehrzeilige Kommentare in Ruby wie ein Codeblock aussehen. Und angesichts der hohen Punktzahl, die für diese Frage vergeben wurde (und der akzeptierten Antwort), sollten die Leute, die an der Ruby-Syntax arbeiten, eindeutig ein wenig darüber nachdenken.

1502voto

Konstantin Haase Punkte 25071
#!/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.
  • So sieht es aus (per Screenshot) - ansonsten ist es schwer zu interpretieren, wie die obigen Kommentare aussehen werden. Zum Vergrößern anklicken :

Comments in a text-editor

147voto

Adam Lear Punkte 36637
=begin
My 
multiline
comment
here
=end

68voto

Rein Henrichs Punkte 15102

Trotz der Existenz von =begin y =end Die normale und korrektere Art, Kommentare abzugeben, ist die Verwendung von # in jeder Zeile. Wenn Sie den Quelltext einer beliebigen Ruby-Bibliothek lesen, werden Sie sehen, dass dies in fast allen Fällen die Art ist, wie mehrzeilige Kommentare gemacht werden.

24voto

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

20voto

the Tin Man Punkte 154584

Entweder mit:

\=begin
This
is
a
comment
block
=end

o

\# This
# is
# a
# comment
# block

sind die einzigen beiden, die derzeit von rdoc unterstützt werden, was meiner Meinung nach ein guter Grund ist, nur diese zu verwenden.

CodeJaeger.com

CodeJaeger ist eine Gemeinschaft für Programmierer, die täglich Hilfe erhalten..
Wir haben viele Inhalte, und Sie können auch Ihre eigenen Fragen stellen oder die Fragen anderer Leute lösen.

Powered by:

X