Ruby
RDoc
YARD

RDocで出力したドキュメント内の任意の箇所で改行したい

RDocで出力したドキュメント内の任意の箇所で改行したい

Rubyのソースコードからドキュメント生成していた際に、
任意の箇所で改行する方法に若干戸惑ったので記載します。

RDocとは?

RDoc は Ruby のドキュメント生成を行うためのライブラリです。
Ruby 2.5.0 リファレンスマニュアル > ライブラリ一覧 > rdocライブラリ

任意の箇所で改行する方法

結論から言うと、改行したい箇所にHTMLの<br>タグを使用することになります。

<br>タグのバリエーションとして、以下の3パターンを試してみます。
1. <br>
2. <br />
3. <BR>

new_line.rb
# coding: sjis

# 1行目<br>
# 2行目
def test01
    nil
end
# 1行目<br />
# 2行目
def test02
    nil
end

# 1行目<BR>
# 2行目
def test03
    nil
end

RDocの出力結果は以下となります。
上記の3パターンの内の<br>だけで改行され、他はそのまま出力されてしまいます。
キャプチャ.PNG

備考

RDocの他にRubyのドキュメント生成ツールのYARDも同様のようです。
※私の場合YARDで<br />と書き込んでみたところ改行されず出来ないものと勘違いしてしまいました。