記述形式


実行結果を示すコメント

サンプルプログラム中に#=>という記述があった場合、その行を実行するとどんな値になるか、どのように表示されるかを#=>の後に示しています。これは、Rubyプログラムの慣習に倣っています。例を以下に示します。

i = 99
i = i + 1 # => 100

この例では2行目でiの値が100になるということを表しています。

なお、xmpfilterを使うとこの形式のコメントを自動生成できます。rcodetoolsに含まれています。

$ gem install rcodetools

破壊的メソッド

解説中で「破壊的メソッド」という記述があった場合、それはレシーバ自体の値を変更するメソッドであることを示しています。

例えば文字列の最後の1文字を取り除くchopというStringクラスのメソッドは破壊的メソッドとしてchop!も用意されています。chopとchop!の動作の違いを以下に示します。

s = "Hello, Ruby!"

s.chop #=> "Hello, Ruby"
p s #=> "Hello, Ruby!"

s.chop! #=> "Hello, Ruby"
p s #=> "Hello, Ruby"

このようにchopメソッドは文字列の最後の1文字を取り除いた文字列を「返却する」だけですが、破壊的メソッドであるchop!はレシーバ(この場合s)の内容自体を変更します。



Comments