たのしいRuby(第２版)　「はじめてのRuby」〜コメントを書く〜

ruby programming

■これは「たのしいRuby 第２版」を元にしています。
http://www.amazon.co.jp/%E3%81%9F%E3%81%AE%E3%81%97%E3%81%84Ruby-%E7%AC%AC2%E7%89%88-Ruby%E3%81%A7%E3%81%AF%E3%81%98%E3%82%81%E3%82%8B%E6%B0%97%E8%BB%BD%E3%81%AA%E3%83%97%E3%83%AD%E3%82%B0%E3%83%A9%E3%83%9F%E3%83%B3%E3%82%B0-%E9%AB%98%E6%A9%8B-%E5%BE%81%E7%BE%A9/dp/4797336617/ref=pd_sim_b_img_6/250-4677527-6737860

コメントを書く

　プログラム中には、コメントを書くことができます。コメントは、プログラム中に書かれていても、直接プログラムとしては扱われません。つまり、プログラムの実行には何の関係もないもの、と言うことです。
　「どうしてプログラムの中に、実行とは関係のない余計なものを書くのだろう？」と思われるかもしれません。確かに一度書いて実行すればそれっきり、というプログラムであれば、コメントは特に必要ないでしょう。しかし、一度書いたプログラムを何度も使いまわすことも少なくありません。そのようなときに、

　・プログラムの名前や作者、配布条件などの情報
　・プログラムの説明

などを書いておくために、コメントが使われます。

いろいろプログラムを見ていると、上記の他にもコメントがあったりします。「モジュールの使い方」であったり、「ここはリファレンスはありません」などといったものもあります。
適度に書いてあると、他の人が見た時に、分かりやすいという利点があります。

ただ、書きすぎは良くないのかなぁと思います。
基本的にはプログラムを読めば全て分かるので、読んだ方が良いと思います。それが真実ですので。

適度が一番。


コメントの書き方

　コメントを表す記号は「#」です。行頭に「#」があれば、1行まるまるコメントになります。行の途中に「#」があれば、「#」の部分から行末までがすべてコメントになります。また、行頭から始まる「=begin」と「=end」で囲まれた部分もコメントになります。これは、プログラムの先頭や最後で、長い説明を記しておくのに重宝します。

ふむ。ではやってみましょう。

  • プログラム
=begin
「たのしいRuby 第2版」サンプル
コメントの使い方の例
　2006/06/26　作成
　2006/07/01　一部コメントを追加
=end
x = 10    #　横
y = 20    #　縦
z = 30    #　高さ
#　表面積と体積を計算する。
are = (x*y + y*z + z*x) * 2
volume = x * y * z
#　出力する
print("表面積", are, "\n")
print("体積", volume, "\n")
  • 実行結果
C:\enjoy_ruby>ruby helloruby.rb
楓ﾊ積2200
体積6000

コメントはまったく無視されて表示されましたね。

コメントは、先ほどあげた目的以外にも、「この行を処理を一時的に実行させないようにする」といったことに使います。

注意：
C言語のコメントのように、行の途中だけをコメントにするような書き方はありません。行末まで必ずコメントになります。

あ、これけっこう使います。プログラムを作成しているときも使えますし、なにかと便利ですが、
バージョン管理されているプログラムをコミットするときに、一部コードがコメントアウトするのはムダな場合があります。バージョンをさかのぼれば発見できるわけですから。





環境

C:\enjoy_ruby>ruby -v
ruby 1.8.6 (2007-03-13 patchlevel 0) [i386-mswin32]