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

初心者向けにRubyのコメントの書き方について解説しています。ソースコード内にその内容についての覚え書きを入れることで可読性を高めることができます。Rubyで一行のコメント、複数行のコメントを入れる場合それぞれの方法について学びましょう。

TechAcademyマガジンはオンラインのプログラミングスクールTechAcademy [テックアカデミー]が運営する教育×テクノロジーのWebメディアです。初心者でもすぐ勉強できる記事が2,000以上あります。

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

Rubyについてそもそもよく分からないという方は、Rubyとは何なのか解説した記事をまずご覧ください。

 

なお本記事は、TechAcademyのWebアプリケーションオンラインブートキャンプの内容をもとに紹介しています。

 

田島悠介

今回は、Rubyに関する内容だね!

大石ゆかり

どういう内容でしょうか?

田島悠介

コメントの書き方について詳しく説明していくね!

大石ゆかり

お願いします!

 

コメントとは

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

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

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

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

 

コメントの書き方

一行コメントの書き方

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

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

 

#コメント

def  ~

end

 

こんな感じになります。

 

複数行コメントの書き方

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

 

=begin 
コメント
=end

 

と書きます。

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

 

[PR] Rubyのプログラミングで挫折しない学習方法を動画で公開中

実際に書いてみよう

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

 

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

train

 

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

 

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

train(1)

 

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

 

筆者プロフィール

町田 耕

学生時代は会計学専攻。塾講師勤務を経て、企業のCFOとして会社経営に携わる。

会社経営から一線を退いた後、インフラエンジニアの妻の勧めでプログラミングを

独学で始め、プログラミングセミナーなど転々としながら、開発案件に携わるようになる。

現在、フリーランスとして活動しながらテックアカデミーのメンターも勤めている。

 

大石ゆかり

内容分かりやすくて良かったです!

田島悠介

ゆかりちゃんも分からないことがあったら質問してね!

大石ゆかり

分かりました。ありがとうございます!

TechAcademyでは初心者でも最短4週間でエンジニアになれるRuby on Railsオンラインブートキャンプを開催しています。

現役エンジニアがパーソナルメンターとして受講生に1人ずつつき、マンツーマンのメンタリングで学習をサポートし、最短4週間でオリジナルWebサービスを開発することが可能です。

また、現役エンジニアから学べる無料のプログラミング体験会も実施しているので、ぜひ参加してみてください。