2010年9月3日金曜日

開発中のバージョンのマニュアルを参照する



railsで勉強していると、結構頻繁にバージョンアップされてて、それに伴い命令等も変わっていました。





なので古いバージョンで開発して、何年か後にメンテナンスが発生したら、マニュアルはどうするんだろうと思ってました。





どうもその辺もしっかり考えられているようで・・・





ドキュメントを作成する


開発中のバージョンのドキュメントを作成する。




  • rake doc:rails


作成したドキュメントを参照可能にする




  • gem server


最後にブラウザで、http://localhost:8808/ にアクセスしたらOK。





おまけ


以下で開発中のアプリがしようしているプラグインのドキュメントが生成される。




  • rake doc:plugins





あと開発中のアプリ自体のドキュメントを作成




  • rake doc:app


こりゃ便利だ。





感想


ただし、このマニュアルは初心者が見てもよく解りません。


知りたいところに辿りつけない><


かつ全て英語だし。





検索機能をつけて、知りたいところを探しやすくするとか改善してほしいなぁと思いました。





0 件のコメント:

コメントを投稿