ruby クラス・メソッド仕様のドキュメント自動生成
2007年07月14日 (土)
ある程度、自分のアプリも大きく育ててきた時点で、自分が作ったcontrollerとかmodelとかのクラスとメソッドの仕様をまとめておきたい、もしくはまとめなきゃ！と思う時が来ると思います。
そんな時は、俺様に任せろコマンドが存在します。
と打てば、あれよあれよという間に以下のコンソール出力と共に、HTML ドキュメントファイルが doc/app の下に作られるので、それをブラウザで見れば良いわけです。
これは手間いらずです。節約できた時間でゆっくり風呂にでもアヒルのおもちゃ（通称：村長）を浮かべて入りましょう。
【広告】
そんな時は、俺様に任せろコマンドが存在します。
rake doc:app
と打てば、あれよあれよという間に以下のコンソール出力と共に、HTML ドキュメントファイルが doc/app の下に作られるので、それをブラウザで見れば良いわけです。
(in /home/roruser/myApp)
rm -r doc/app
.
.
.
Generating HTML...
Files: 109
Classes: 134
Modules: 63
Methods: 445
Elapsed: 13.960s
これは手間いらずです。節約できた時間でゆっくり風呂にでもアヒルのおもちゃ（通称：村長）を浮かべて入りましょう。
【広告】