Rdoc

参考
RDoc Documentation

コマンドプロンプトで空のフォルダに移動して"rdoc"と入力。

Files: 0
Classes: 0
Modules: 0
Methods: 0
Elapsed: 0.010s

と表示される。ActiveScriptRubyでインストールしたが、一緒に入っているらしい。

ドキュメントにしたいソースコードが入っているフォルダでrdocを実行すると、その下にあるソースコード全てのコードが対象。サブフォルダも含む。出力結果はカレントディレクトリのdocの下にhtml形式で保存される。
index.htmlを開くと、4つのフレームに分割されたページが表示される。
上部3つは左から、ファイル、クラス、メソッドのリンクになっている。クラス、メソッドはどのファイルに入っていたかに関係なくアルファベット順に並ぶ。ただし、メソッドにはクラス名が一緒に表示されている。
それらの下に選択したファイルなりクラスなりの説明が表示される。
説明ページはファイルとクラスごとに作られる。メソッドのリンクをクリックした場合は、クラス説明の中の該当メソッドが表示される。