RDocドキュメンテーション

RDocはRubyソースコード用のドキュメンテーションシステム。 Javadocと同様、ソースコードの構文情報とコメントブロックのテキストを使って、多数のソースファイルからHTMLドキュメンテーションを生成する。
Javadocと異なり、ソースにコメントが全くなくても、充実したドキュメントを生成できる。

・riコマンドで標準ライブラリのドキュメントを表示可能。

>ri String.capitalize

・RubyGemsを使ってRailsをインストールした場合、gem_serverを実行した上で、下記からRails APIを参照可能。

http://localhost:8808/

・RailsプロジェクトのHTMLドキュメンテーションを作成するには、下記タスクを実行。

>rake doc:app
→doc/appディレクトリに配置される。


















最終更新:2008年05月26日 17:50
ツールボックス

下から選んでください:

新しいページを作成する
ヘルプ / FAQ もご覧ください。