読者です 読者をやめる 読者になる 読者になる

maeshimaの日記

メモ書きです

RDocの基本的な書き方メモ

メモ

Railsで使うRDoc生成用rakeコマンド

rake doc:app
rake doc:plugins

見出し

#=
#==
#===

コメント

#--
# RDoc的なコメント
#++

リンク

http://example.com/ 

のようなリンクは自動でリンクが張られる。

hoge[http://example.com/]

のようにすると

<a href="http://example.com/">hoge</a>

のようになる。

リスト

# - '*' もしくは '-' で普通のリスト
# - 数字+ピリオドで番号付きリスト
# - アルファベット+ピリオドでアルファベットリスト

注意点

rake doc:plugins

等でRDocを生成してから、ファイル修正→再度生成とすると、前回生成時点より新しいファイルしか生成が行われない。なのでRDocファイルを一度削除してから再度生成する必要がある。

rake doc:app は実行時に削除→作成としてくれるけどrake doc:pluginsはなぜか最初に削除されない。注意