Ruby 逆引きレシピ レシピ213-216
Ruby 逆引きレシピ すぐに美味しいサンプル&テクニック 232 (PROGRAMMER’S RECIPE)
- 作者: 島田浩二,設樂洋爾,村田賢太,前田智樹,谷口文威
- 出版社/メーカー: 翔泳社
- 発売日: 2009/07/25
- メディア: 単行本(ソフトカバー)
- 購入: 16人 クリック: 349回
- この商品を含むブログ (77件) を見る
今日はレシピ 213 から 216 までを読みました。
第13章のドキュメンテーション/パッケージ化のところです。
レシピ 213 より、RDoc の解説。恥ずかしながら、RDoc の使い方ちゃんと知りませんでした。単にメソッドの前にコメントを書くだけでもそれがメソッドの説明として整形されるんですね!これからは RDoc でドキュメンテーションできるようにこまめにメソッドを書くようにしようと思いました。また、慣習的な書き方というのが紹介されているのも嬉しいところです。
レシピ 214 より、YARD というツールを使うと、Javadoc や Doxygen のようにより規約が決まった記法でドキュメント生成できるようです。
レシピ 215 より、Exerb を使うと Windows 環境で Ruby 本体とスクリプトをまとめてひとつの exe 形式のファイルにまとめることができ、配布に便利です。Windows じゃないので試していません。
レシピ 216 より、setup.rb の使ってインストールするための手法が紹介されています。と言ってもディレクトリ構成を適切にしておけばあとは setup.rb がうまくやってくれるようです。
パッケージ化については、今だと RubyGems パッケージの作り方のほうが求められそうに思えます。最近の定番の手法はどんなものなのでしょうか?