mirror of
https://github.com/ruby/ruby.git
synced 2022-11-09 12:17:21 -05:00
bddb31bb37
* Top-level `return`; * Documentation for comments syntax; * `rescue` inside blocks; * Enhance `Object#to_enum` docs; * Make `chomp:` option more obvious for `String#each_line` and `#lines`; * Enhance `Proc#>>` and `#<<` docs; * Enhance `Processs` class docs.
37 lines
647 B
Text
37 lines
647 B
Text
= Code Comments
|
|
|
|
Ruby has two types of comments: inline and block.
|
|
|
|
Inline comments start with the <code>#</code> character and continue until the
|
|
end of the line:
|
|
|
|
# On a separate line
|
|
class Foo # or at the end of the line
|
|
# can be indented
|
|
def bar
|
|
end
|
|
end
|
|
|
|
Block comments start with <code>=begin</code> and end with <code>=end</code>.
|
|
Each should start on a separate line.
|
|
|
|
=begin
|
|
This is
|
|
commented out
|
|
=end
|
|
|
|
class Foo
|
|
end
|
|
|
|
=begin some_tag
|
|
this works, too
|
|
=end
|
|
|
|
<code>=begin</code> and <code>=end</code> can not be indented, so this is a
|
|
syntax error:
|
|
|
|
class Foo
|
|
=begin
|
|
Will not work
|
|
=end
|
|
end
|