コメントの書き方

このレッスンでは、Rubyにおけるコメントの書き方を学び、あとから読み返しても分かりやすいコードを書けるようになることを目標にします。「Ruby コメントアウト 書き方」で調べている方向けです。

コメントは、実行には影響しない「人間向けのメモ書き」です。#で1行コメントになります。複数行には=begin〜=endも使えます。

サンプルコードでは、#を使った1行コメントと、=beginから=endまでの複数行コメントを使い分けています。実行結果にはこれらのコメントは一切影響せず、あくまで人間が読むための説明として機能している点を確認してみましょう。

初心者がよくつまずくのが、コメントを書きすぎてしまい、かえってコードが読みにくくなるケースです。「何をしているか」はコード自体を読めば分かることが多いため、コメントには「なぜこの処理が必要なのか」という背景を書くのが効果的です。

一時的にコードを無効化したいとき(コメントアウト)にもよく使われる、実務でも欠かせない書き方です。デバッグ時に特定の行だけを一時的に無効化して動作を確認する、という使い方も頻繁に行われます。