Rubyのコメントの書き方を現役エンジニアが解説【初心者向け】

Rubyのコメントの書き方について解説します。

 
そもそもRubyについてよく分からないという方は、Rubyとは何なのか解説した記事を読むとさらに理解が深まります。

なお本記事は、TechAcademyのオンラインブートキャンプRuby講座の内容をもとに紹介しています。

 

 

コメントとは

今回はRubyのコメントについて紹介していきます。

いろいろとコードを書いていくと、そのコードの意味などを、きちんと日本語だけでなく、明示しておいた方が便利な場合が多々あります。

しかし、コードに日本語にみならず、任意の好きな言葉を書いてしまうと、それにプログラムが反応してしまい、エラーなどのバグを生じさせます。

このような場合にプログラムに反応させることなくコードにメモ書きを残すことをするために、コメントという機能がRubyには備わっています。

 

コメントの書き方

一行コメントの書き方

まずコメントの書き方ですが、こちは行の先頭に#を書くだけです。

これだけでその行がコメント扱いとなり、コードでは無視されることになります。

 

#コメント

def  ~

end

 

こんな感じになります。

 

複数行コメントの書き方

複数行コメントの書き方としては

 

=begin 
コメント
=end

 

と書きます。

=beginと=endに囲まれたところがコメントとなりプログラムのコード上無視されることとなります。

 

[PR] 未経験からWebエンジニアを目指す方法とは

実際に書いてみよう

それでは実際に書いてみましょう。

 

#電車と表示します。
def train
  puts "電車"
end

train

 

こちらのメソッドを実行するときに、#の行は無視されますが、どのようなメソッドであるかを明示していますので、後になって確認することができます。

 

=begin
1番なら急行列車と表示
それ以外なら各駅停車と表示
=end
def train(x)
  if x == 1
    puts "急行列車です"
  else
    puts "各駅停車です"
  end
end

train(1)

 

2行以上になるコメントの場合はこのように記述しても良いです。

 

筆者プロフィール

町田　耕 学生時代は会計学専攻。塾講師勤務を経て、企業のCFOとして会社経営に携わる。 会社経営から一線を退いた後、インフラエンジニアの妻の勧めでプログラミングを 独学で始め、プログラミングセミナーなど転々としながら、開発案件に携わるようになる。 現在、フリーランスとして活動しながらテックアカデミーのメンターも勤めている。

 

 

TechAcademyでは、初心者でもRuby on Railsを使ったプログラミングを習得できるオンラインブートキャンプRuby講座を開催しています。

挫折しない学習方法を知れる説明動画や、現役エンジニアとのビデオ通話とチャットサポート、学習用カリキュラムを体験できる無料体験も実施しているので、ぜひ参加してみてください。