Rails.GrAFR

Javaには JavaDocとよばれる、JavaのソースコードからHTML形式のAPI仕様書を作成してくれるものがありますよね。

①ドキュメントの生成方法・コマンド

ruby では RDoc と呼ばれるものがあります。
今回は Rails で RDocを使用する方法を書いておきます。

# 現在のアプリのドキュメントファイルを作成する
$ rake doc:app

# アプリのドキュメントファイルを削除する
$ rake doc:clobber_app

# 現在あるドキュメントを強制的に上書きする
$ rake doc:reapp


# railsに関するドキュメントを作成する
$ rake doc:rails

ほかは [ rakeのタスク一覧 ] に書いてあるので見てみて下さい。

②RDoc の書き方

次に, RDoc の書き方については、以下の記事が参考になります。

• http://tech.feedforce.jp/review_rdoc.html
• http://ruby.gfd-dennou.org/tutorial/rdoc/
• http://webos-goodies.jp/archives/51072281.html