RDocTemplate

メソッドコメントのテンプレート（日本語版）

メソッドコメントは以下の形式が多いようだ。

#
# === 概要
#
# （ここにメソッドの概要を記述します）
#  メソッド呼び出し形式(引数省略など)が書かれることが多いようです
#
# === 引数
#
# +仮引数名1+::
# （ここに仮引数の説明を記述します）
# +仮引数名2+::
# （ここに仮引数の説明を記述します）
#
# === 戻り値
#
# （ここに戻り値の説明を記述します）
#
# === 例外
#
# +例外クラス+:: 例外の発生条件
# +例外クラス+:: 例外の発生条件
#
# === 詳細
#
#  ここに詳細説明を記述します。
#  * 箇条書きする場合は、
#  * と空白を最初に書いてから各項目について記述します
#
# === 例
#
# 必要に応じてここに例を記述する。
# 呼び出し結果は、#=> の後ろに記述する。
#
# func(a, b, c) #=> 32
#
def func(...  ← メソッド定義式の開始

HTML生成のエンコーディングオプション

少なくとも、1.8形式（shbang行のKオプション）の文字コード認識はしてくれないので、コマンドラインオプションで指定する。

rdoc --charset=shift_jis foobar.rb

このページについて

RDocの形式について調べていたのだが、それにしてもRDocの記述説明が見当たらないので、先行公開します。