Rubyで複数行のコメントアウトをする方法を現役エンジニアが解説【初心者向け】

初心者向けにRubyで複数行のコメントアウトをする方法について現役エンジニアが解説しています。プログラム内の注釈や説明文をコメントと呼び、プログラムのソースコードの一部をコメントにすることをコメントアウトと言います。=begin-=endを使う方法や#で1行コメント、_END_などがあります。

TechAcademyマガジンはオンラインのプログラミングスクールTechAcademy [テックアカデミー]が運営。初心者向けに解説した記事が4,000以上あります。現役エンジニアの方はこちらをご覧ください。

Rubyで複数行のコメントアウトをする方法について、TechAcademyのメンター(現役エンジニア)が実際のコードを使用して初心者向けに解説します。

 

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

 

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

田島悠介

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

大石ゆかり

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

田島悠介

Rubyで複数行のコメントアウトをする方法について詳しく説明していくね!

大石ゆかり

お願いします!

 

コメントアウトとは

プログラム内の注釈や説明文を「コメント」と呼びます。

プログラムのコードを「コメント化することによって無効化する」ことを「コメントアウト」と表現します。プログラムコードをコメントにしてしまうことで、その部分が実行されないようにするわけです。

なぜわざわざそんなことをするのでしょうか?

ベテランがプログラムを修正するときは必ず「もとに戻す」ことを意識しながら修正します。
もとのコードはどうなっていたっけ? もとのコードはなぜだめだったんだっけ? 修正すべきコードはここじゃなかったのかもしれない。

闇雲に修正してうまく行かなかったときに、既存のコードを上書きしてしまっていると、もとに戻せなくなります。

そうならないために、プログラムを修正するときは今動いているコードを「いったんコメントアウト」して、新たな行にコードを書き直すようにします。
そうすることで、既存のコードと見比べることもできるし、いざというときは「もとに戻す」ことも簡単です。。

そんなふうに、コメントの機能を使ってプログラムコードを無効化することを「コメントアウトする」と表現します。
 

複数行のコメントアウトをする方法

複数行をコメントアウトする方法

複数行をコメントアウトする場合は、「=begin」 から 「=end」 まですべての行がコメントになります。「 =begin =end 」を使う場合は、ソースの1カラム目から記述する必要があります。
 

1行をコメントアウトする方法

Rubyでは シャープ記号( # )があると、シャープ記号( # )からその行の末尾まではすべてコメントになります。
 

特殊な方法

ヒアドキュメント「__END__」をソース中に記述すると、「__END__」 以降は解析・実行の対象にならないのでその部分にデータを書き込んでおくことができます。

「__END__」 以降に記述した情報(データ)は、組み込み定数「 DATA 」で読み込めるようになります。「 DATA 」はFileクラスのオブジェクトです。
 

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

実際に書いてみよう

=begin
 複数行の
 コメントを
 書くことができます。
 ※ソースの1カラム目に記述する必要があります。
=end
# コメント行 :この行全体がコメントになります。
puts "hello" #←ここから行末までコメントになります。
__END__

 これ以降はDATAを書き込んでおくことができます。
 ここに書いた情報はプログラムで読み込むことができます。
 コメント部分としてつかうこともできますが、本来の使い方ではありません。

 

まとめ

まとめてみしょう。

  • プログラムソース中に書く説明文や注釈を「コメント」と言います。
  • コードをコメント化して実行されないようにすることを「コメントアウト(する)」と言います。
  • プログラムを修正するときは上書きで修正するのではなく、いったんコメントアウトしておくと便利。

「コメントアウト」を活用して慎重にコードを修正しましょう。
 

筆者プロフィール

メンター古川さん

Rubyが得意で、Webエンジニアとして最上流から最下流までセルフスターターとして活躍してきました。

近年セミリタイアし、フリーランスとして適度に働きながら穏やかな生活を楽しでいます。

 

大石ゆかり

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

田島悠介

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

大石ゆかり

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

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

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