Ruby RDoc - ありの日記

RubyにもRDocという、JavaDocと同じようなツールがある。
どのRubyにも初めから入っているものかは分からないが、
私が入れたRubyには既に入っていた。

インストールされているか確認するには、コマンドラインから次のコマンドを実行してみるとよい。
> rdoc -h

これでヘルプが表示されればインストール済みということだ。

操作方法は簡単で、次のように入力するとカレントディレクトリ以下のRubyファイルを再帰的に検索して、自動的にHTMLを出力してくれる。

> rdoc

ファイルがShift_JISで書かれている場合、次のオプションを指定して実行する。

> rdoc --charset shift_jis

すると、カレントディレクトリに「doc」ディレクトリが出来上がる。
このディレクトリの「index.html」を開いてみるとソースに書いたドキュメントがHTMLとして表示されることが分かると思う。