近所の図書館にあったので今更ながら借りてきた。
プログラミング学習シリーズ Ruby 1 はじめてのプログラミング
- 作者: arton,宇野るいも
- 出版社/メーカー: 翔泳社
- 発売日: 2009/01/29
- メディア: 大型本
- 購入: 5人 クリック: 95回
- この商品を含むブログ (30件) を見る
で、Rubyに関しての説明では、オブジェクト指向を中心にしていないので、Rubyの教科書としては主流になり得ないと思われ。メソッドではなく「関数」と書いてるし。
でも所々にtipsが載っているのでメモしていきます。見出しが載っていた文で、それ以降が私の独り言です。
関数を作る目的のほとんどは、プログラム内で同じようなことを書かなくても済むように、プログラム内の共通化できるコードを一箇所にまとめること
(第5章 数値計算と関数 5-3 関数の定義 p.127)
もちろんここで書かれている「関数」とは、Rubyだとメソッドなのです。関数と言ってしまうと、オブジェクト指向の方々から叱責を受ける気がするんですけど、でも初学者には関数のイメージの方がやりやすいと思うので、私もここでは「関数」と書かれていてる方がありがたいです。
Rubyの関数名は英字で開始して、英数字または_をつなげます。Rubyの規約では、英大文字を使わず、複合語を関数名にする場合には_で区切ります
(第5章 数値計算と関数 5-3 関数の定義 p.131)
「規約」とまで言ってしまっていいのですかね。でもこれに従ってやったほうがいいのは、いろいろ見ているうちに分かってきました。
関数名は「動詞+目的語」の形式が一般的
(第5章 数値計算と関数 5-3 関数の定義 p.135)
この形式でやっていく!と決めればどーでも良いとは思うのです。でも「動詞+目的語」に落ち着きそうな気はしますw
(メソッドの)仮引数の並び順
- 固定的な情報を先に、呼び出し毎に変わる情報を最後に(単に筆者の好みです)
- そのほかに、「関数内で参照される順に並べる」
(第5章 数値計算と関数 5-3 関数の定義 p.136)
ハッシュは後ろにした方が便利ですよね。
関数のコメントはRDocが処理できる形式で上記の情報(引用者註:引数・処理・戻り値)を記述します
(第5章 数値計算と関数 5-3 関数の定義 p.138)
コメントを書くを初学者の頃から付けさせるのは非常に大事なことだと思います。私自身は、明日の自分のためにコメント付けしてますけどねw
おまけ:RDoc参考リンク
- RDoc による自動ドキュメント生成
- いますぐ始める RDoc によるドキュメント生成 - WebOS Goodies
- rgss-lib コメント規約
- プログラミング言語/Ruby/RDoc - プログラミングスレまとめ in VIP
さらにおまけ:YARD参考リンク