Rubyのコメントの書き方

logo_long

前回:>> 文字や数値を表示しよう!
次回:>> Rubyの変数5種類の解説とサンプル、有効範囲(スコープ)について




プログラムにはコメントを書こう

Rubyに限らずどんなプログラム言語でもコメントというのを書くことができます。
(※もしかしたらコメント書けないプログラム言語があるかも知れませんが・・・)

コメントというのはプログラムの命令とか動作とは関係なく、補足説明を書くことができます。

なぜコメントを書くのか?

プログラムを書いてる時はいいんですけど、後で見返すと、まぁ意味が分からない分からない!!
自分が書いたものでも分からないのに、他人が書いたものなんてさっぱり分からない、分かるわけが無いっ!!(笑)
 

もう少しちゃんと言うと、書いている内容は分かるんだけどなぜそういう書き方をしたのか?それが分からなくなるんです。

なので、コメントとして処理の内容をきっちり書いておく必要があるのです。

 

プログラムを書いている時の自分
『この処理はこう書くしかねーーーんだよ!!! こんなもんコメント書かんでも分かるやん!!!』

一ヶ月後の自分
『あれ・・・???? なんでこんな書き方してんの? こうじゃなくて○○な手順の方がええんちゃうの?』
  ↓
  ↓(書き直す)
  ↓
『あれ?? うまく動かへん。なんで・・・? 元戻そ・・・』

 

みたいな事に、しょっちゅうなります。マジで!!

なので、、、

 

コメントは『しっかり』『ちゃんと』『分かりやすく』書きましょう!
マジで!

 

Rubyにおけるコメントの書き方

Rubyでのコメントの書き方は二種類あります。

一行モノ

説明

#(シャープ)を使います。
# より後ろがコメントと認識されます。
# より前はコメントにはなりません。

サンプル

# これがコメントです。
puts "ほげほげ"    # ここにも書けます。
# puts "ふがふが"  # プログラム命令をコメント化することをコメントアウトと言うことがあります
# puts "はげはげ"  #     〃
# puts "べろべろ"  #     〃

複数行モノ

説明

一気に複数行をコメントアウトしたい場合、一行ずつ#を付けると面倒なので別の書き方をします。

=begin=end で囲みます。

サンプル

# これがコメントです。
puts "ほげほげ"    # ここにも書けます。
=begin
puts "ふがふが"    # こめんと
puts "はげはげ"    # コメント
puts "べろべろ"    # comment
=end

前回:>> 文字や数値を表示しよう!
次回:>> Rubyの変数5種類の解説とサンプル、有効範囲(スコープ)について


 

 

おすすめ書籍

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

ABOUTこの記事をかいた人

Windows/Mac/Linuxを使う現役システムエンジニア&プログラマ。オープン系・組み込み系・制御系・Webシステム系と幅広い案件に携わる。C言語やC#やJava等数多くのコンパイラ言語を経験したが、少し飽きてきたので、最近はRubyやPython、WordPressなどのWeb系を修得中。初心者向けのプログラミング教室も運営中。オンライン・対面・出張等でプログラミングをレッスンします。