💭
[Feature #19688] 新しいブロックコメントの記法の提案
[Feature #19688] Add indentable block comment syntax
- Ruby では
=begin ~ =end
を利用する事でブロックコメントを書くことができる - ただし
=begin ~ =end
はインデントできないので次のような形になってしまう
class A
class B
class C
=begin
The comment for this method
=end
def hello
end
end
end
end
- これを改善するために次のように
#begin ~ #end
のブロックコメントを追加する提案
class A
class B
class C
#begin
The comment for this method
@param str
@return [String]
Any other document. Now we are easy to break
a line, without touching the leading `#` like before.
#end
def hello(str)
end
end
end
end
- これめっちゃほしい〜〜〜と思いつつ
#begin ~ #end
の記法だと互換性がないのでこのチケット自体はreject
されています- https://bugs.ruby-lang.org/issues/19688#note-5
- 必要性自体は理解しているのでもっといい記法があればワンチャンあるかもね
Discussion