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

rdocを調べてみた

Ruby Rails

ちょっとだけrdocを調べてみたのですが、
これって書いたソースから文章を抽出して
ドキュメントを作る最良の方法ではないでしょうか。
これをつかってソースコードにコメントを埋め込むと、
引き継いだ人なんかは分かり安いことこの上ないです。

rdoc app lib -U --op rdoc -c UTF-8 --template kilmer

コマンドでrdocというディレクトリにhtml形式で
ドキュメントを作成してくれます。
こちらを参考にするといいでしょう。
http://ruby.gfd-dennou.org/tutorial/rdoc/
こちらもいいですね。
http://pub.cozmixng.org/~the-rwiki/rw-cgi.rb?cmd=view;name=RDoc%B3%D0%A4%A8%BD%F1%A4%AD