【リニューアル記念】未経験からブロガーへのSTEPを続々更新!

プログラミングにおけるコメントの書き方!基本は書かないがルール!

プログラミングのコメントは書かない

プログラミングには「コメント」というものがあります。

コメントは、「プログラムに影響を与えない文字」のことです。

つまり、コメントはあってもなくても、実際のプログラムには何の影響も与えない存在なのです。

「プログラムに影響がないなら書く必要ないじゃん!」

そんなことを思う方もいるでしょうが、実はコメントを残したいタイミングというものがあるのです。

  • コードに対するメモを残したいとき
  • 一時的にコードを無効にしたいとき

ただ、ここで1点気を付けなければいけないことは、コメントを書き過ぎないこと

これは特に、プログラミングを始めたばかりの初心者の方に多いです。

コメントは誰でも簡単に書くことができるため、「あってもなくてもいいようなコメント」をたくさん残してしまいがちなのです。

コメントがたくさんあるとコードの邪魔になり、良かれと思って残したメモが「逆にコードをわかりづらくさせてしまう」なんていうのはよくある話です。

大切なのは、自分の中で「コメントを使うためのしっかりとした基準」を持っておくこと。

この「基準」を持っているかどうかが、綺麗で読みやすいプログラムを書く上で重要になってきます。

今回は、そんなコメントの「書き方」や「基準」について詳しく解説していきます!

プログラミングにおけるコメントの書き方

コメントの書き方はプログラミング言語によって違いますが、構成はほとんど同じです。

メモしたい行の先頭に記号をつけたり、無効化したいコードを記号で囲うことで「コメント」として扱われるようになります。

では、さっそくコメントの具体的な書き方をいくつか見ていきましょう。

C、Java、PHPにおけるコメントの書き方

まずは、「C」「Java」「PHP」のコメントの書き方です。

C・JAVA・PHPのコメント
// この一行がコメント
/*
  この複数行をまとめてコメント
  この複数行をまとめてコメント
*/

「//(スラッシュ2つ)」以降がコメントになります。

これはあくまで「//」がついている行のみが対象です。

複数行をまとめてコメントにしたいときは、「/*」を「*/」を使って対象のコードを囲む必要があります。

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

次に「Perl」のコメントの書き方です。

Perlのコメント
# この一行がコメント
=comment
  この複数行をまとめてコメント
  この複数行をまとめてコメント
=cut

「#」がついている行がコメントになります。

複数行をコメントにするときは、「=comment」と「=cut」で無効化したいコードを囲います。

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

最後は「Ruby」のコメントの書き方です。

Rubyのコメント
# この一行がコメント
=begin 
  この複数行をまとめてコメント
  この複数行をまとめてコメント
=end

Perlと似ていますが、複数行をコメントにする書き方に少し違いがあります。

複数行をコメントにするときは、「=begin」と「=end」を使ってコードを囲まなければなりません。

キツネ

コメントを書くのはとっても簡単だね!

コメントアウトとアンコメント

プログラミングをしていると、コードを一時的に無効化したい場合があります。

たとえば以下のような場合です。

  • 機能を作るためプログラミングしたのはいいけど、今すぐは使わないとき
  • デバッグする際に、一時的に関係ないコードを無効化して見やすくしたいとき

このように、一時的にコメントを使ってコードを無効化することを「コメントアウト」といいます。

これとは逆に、コメントを外して元のコードに戻すことを「アンコメント」といいます。

たまに、「コメントアウトの反対はコメントインだと思ってた!」という方もいるので、今のうちに正しい用語を覚えておきましょう!

コメントを書く「基準」や「コツ」

ここまでコメントの書き方について、詳しく説明してきました。

ですが、コメントは「基本的には書かないほうがいい」ということを覚えておいてください。

コメントをいつでも使えると考えていると、「他の誰が見ても読みやすいコード」を意識しなくなり、コメント頼りで読みづらいソースコードになってしまいます。

キツネ

コメントに頼ったソースコードは品質が低くなりがちだよ!

また、コードを修正するときにコメントの書き換えを忘れてしまうと、「嘘のコメント」が残り続けてしまい、多くのプログラマーを無駄に悩ませる原因となります。

基本的には、コメントがなくても読みやすいソースコードを心掛けることが大切です。

コメントを書く際に気にするべきポイントや、ちょっとしたコツについても見てみましょう!

コメントが必要?書かないことも大切!

さきほどもお伝えしましたが、コメントは「書かなくていいことがほとんど」です。

書いたコードに対して「コメントがあったほうが読みやすいだろう…」と、1つ1つ丁寧にコメントしている方もいるでしょう。

ですが、コメントがなくても読みやすいコードを書くことのほうが重要なんです。

「コメントがないと読めない!」なんてコードは、プログラム全体を複雑化させてしまいがちです。

また、コードの理解を助ける目的で書いたコメントであっても、コメント自体の数が多ければ必然と行数も増え、ソースコードが見づらくなってしまいます。

これでは本末転倒ですよね。

コメントを書くときは、本当にコメントが必要かどうかを考えてみましょう。

  1. コメントがなくてもコードを理解できるか考える
  2. コードが読みづらければ、まずはコードを書き換える(リファクタリング)
  3. それでもコードが複雑であれば、コードを要約できるようなコメントを書く

まずはコードを読みやすくし、「コードよりもコメントを読んだほうがあきらかに理解が早い!」と自信をもって思えた場合のみコメントを書きましょう。

ここで初心者に多い、悪いコメント例を1つ紹介します。

悪いコメント
# ユーザー情報を取得する
get_user(1)

# ユーザー情報を取得する関数
def get_user(id)
  処理
end

このようなコメントなら書かないほうがいいです。

コメントが無くても、関数名を見るだけで何をしているのか十分わかりますよね?

コメントが見やすいか

コメントは見やすくなければいけません。

自分にしかわからない言葉を使っていないか?

まわりくどい表現になっていないか?

コメントは、常に読み手のことを考えて書くことが大切です。

格好つけて英語でコメントを書くより、わかりやすい日本語で書いたほうがいいのです。

もちろん、英語がわかる方に向けたコメントなら英語でもいいでしょう。

ですが、あきらかに日本人しか見ないようなプログラムに、わざわざ英語を使って読み手の負担を増やす必要はありませんよね。

TODOなどのメモを残したいとき

コメントはコードを説明する目的以外にも、メモなどに使う場合もあります。

「この箇所にあとで処理を追加する必要がある!」

「この処理はもう少し読みやすくしたほうがいい!」

こういった場合は忘れないように、ソースコード上に一時的にメモを残すのです。

メモを残す場合、それがメモだとわかりやすいようコメント記号のあとに「TODO」などと書くことが多いです。

TODOコメント
# TODO: この関数をリファクタリングする
def get_user(id)
  処理
end

あくまで一時的なので、必要なコードを書いたあとはTODOコメントは消さなければいけません。

ずっとTODOが残っているような場合は問題だと思いましょう!

コメントアウトしたいとき

プログラムの調査や動作確認をする際に、一時的にコードをコメントアウトしたい場合があります。

Rubyのコメントアウト
# hoge(100, 200)
=begin 
  def hoge(a, b)
    puts a * b
  end
=end

上のコードは、すべてコメントアウトされています。

コメントアウト自体は何も悪くないので、必要であればどんどん使いましょう!

ですが、調査やデバッグした際にコメントアウトしたコードが残り続けることは問題です。

コメントアウトは一時的に使うものであり、確認などが終わったタイミングでアンコメント、もしくは削除しなくてはなりません。

ですが実際には、メモの用途で使ったコメントアウトが残り続けているケースがたくさんあります。

他のプログラマーがこれを見ても、「何のために書いてあるのかはわからないけど、残しておいたほうがいいんだろうな…」と変な気を遣ってしまい、消されることなく永遠と残り続けるのです。

これは本当に無駄なコードなので、絶対に残さないようにしましょう!

さいごに

今回は、プログラミングにおける「コメント」について解説しました。

コメントも実は奥が深く、読みやすいコード(リーダブルコード)を書くためにはいくつかのテクニックが必要です。

コメントの使い方をしっかり理解し、より見やすいコードを書けるように心がけましょう!

また、コメントに限らず「リーダブルコードをもっとしっかり学びたい!」という方はこちらの本がおすすめです。

僕もこの本を読んで、リーダブルコードを学びました。

コメントを書く基準についてはもちろん、変数や関数の書き方から、見やすいコード関するすべてのことが書いてあります。

内容もとてもわかりやすく、読んだあとすぐに実践できるものばかりです。

この本を読み終えた当時の僕は、「もう迷わないでプログラミングできる!」と強く感じ、開発速度がグンと上がったことを覚えています。

これはおそらく、コーディングするたびに「どう書くことがベストなんだろう…」と悩んでいた時間がなくなったことが大きいです。

本自体も小さく薄いので持ち運びやすく、電車の中でサッと読めるのも魅力的でした。

「コードを書くたびに、いつも迷いながら書いている」という人にこそ読んで欲しい一冊です!

テキストのコピーはできません。