Ruby 2.2.0 リファレンスマニュアル > ライブラリ一覧 > rdoc/contextライブラリ > RDoc::Context::Sectionクラス > set_comment

instance method RDoc::Context::Section#set_comment

set_comment(comment) -> ()[permalink][rdoc]

自身にコメントを設定します。

[PARAM] comment:
文字列を指定します。

comment の最初の行に :section: を含んでいた場合、その行以降の文字列をコメントとして設定します。そうでない場合は comment すべてをコメントとして設定します。

# ---------------------
# :section: The title
# The body
# ---------------------