今回の講義ではコメントアウトについて学んでいきましょう。 実は「優秀なプログラマーはコメントアウトが上手」と、コメントアウトはプログラマーの力量を測るポイントにもなっています
なんと！ それなら頑張って覚えますよー。 わたしは、優秀だと思われたくて仕方ありません
ところで、コメントアウトってなんですか？ なんとなく想像はつきますけど……
そうですね。では、まずコメントアウトの説明からいきましょうか
PHPの学習：コメントアウトはどんな機能？
コメントアウトとは、「プログラムの中にコメントを残す機能」を指します。 言い換えればメモ書きのようなものですね
なんとなくそんな気はしました。 どんな目的で使うんですか？
コメントアウトを使うとコードがわかりやすくなる
最大の目的は、コードをわかりやすくすることです。
とくに複数人でプログラミングをするときには、他の人たちに「こんなコードを書いたよ」とコメントアウトで伝える必要があります。チームで作業をする際には、コメントアウトが必須ですよ。
そっか。 人の書いたコードの意味がわからないと、仕事にも影響が出るもんね
もちろん、自分用のメモとしてコメントアウトをするケースも多いです。
上手なコメントアウトのやり方とは
さっき「上手なコメントアウト」と言ってましたが、コメントアウトに上手いとか下手とかあるんですか？
簡単に言うと、伝えるべき箇所を伝えている人が、上手にコメントアウトできる人です。なんでもかんでも伝えればいいというものでもありません
わかるー 話が長いおじさんは嫌われるよね
コメントアウトはやりすぎないのがコツです。 たとえば、以下の画像を見てください。緑の文字がコメントアウトされた箇所です。
なんか……とても多いですね
話が長いおじさんだねぇ
これは全ての処理に対してコメントアウトを記載しているパターンですね。
コメントアウトの練習ならこれでも良いのですが、実際にプログラミングの現場でここまでコメントアウトをしていたら、莫大な時間がかかってしまいます。
もっと内容を簡潔にまとめてコメントアウトしましょう。
では、こちらのコメントアウトはいかがですか？
さっきよりもだいぶコメントの量が減っていますね。でも、何が書かれているのかは、きちんとわかります
そうですね。 だから、こっちのコメントアウトのほうが一緒に働いている人たちからは好まれやすいんですよ。 コメントアウトにかかる時間も大幅に短縮できます
コメントアウトは基本、自由
コメントアウトの目的は、どのような処理をしているのかを分かりやすくすることです。だから、極論を言えば担当者が理解できれば、どんな内容でも構いません。
たとえば、「なぜかは分かりませんが、この行を消すとエラーが出ます」、「ここの処理は実装には関係ないと思われます」のようなコメントアウトでもOKです。
PHP学習：3種類のコメントアウト方法
続いて、コメントアウトのやり方を紹介しますね。PHPでは下記の3つの方法でコメントアウトをします
- 行頭に「//」を入力する（入力した行がコメントアウトの範囲）
- 行頭に「#」を入力する（入力した行がコメントアウトの範囲）
- コメントの範囲を「/*」と「*/」で囲む（囲んだ範囲がコメントアウトの範囲）
この3つのやり方を使い分けるのが、上手なコメントアウトをするポイントです。
基本的には自分のやりたいように使い分ければ良いのですが、少しだけ実例を紹介しましょう
①：「//」は単行のコメントアウトにオススメ
今回のような処理が少ないプログラミングの場合は、それほど使う機会がありませんが、「//」でコメントアウトをする場合は単行での処理を入力するのにオススメです。
1行で処理が完了する場合、その行でどのような処理をしているのかをメモ書きしておくために「//」のコメントアウトを使用します。
②：「#」はその部分の処理で何をしているのかを記入する
あくまでも一例ですが、「//」との使い分けとして「複数行のプログラミングの上部に「#」でコメントアウトする」方法があります。
echoで配列の中身を出力していますが、複数行のプログラミングをしています。その部分をまとめて「#」でコメントアウトする方法です。
「//」が一行で、「#」が複数行ですね。 これは、なかなかわかりやすいと思います
③：「/**/」では、まとめて記入しておきたいことをコメントするのにオススメ
最後に「/**/」でのコメントアウトです。これは、全体をまとめてメモ書きしておくのにオススメです。
今回のケースだと、このようになります。
このようにどのような処理をしているのかを長文で残したいときには「/**/」を使用したほうが分かりやすくなります。
ただ、あくまでも今回紹介した使い方は一例なので、自分にとって分かりやすい方法でコメントアウトしてください。自分なりのルールを作るのが大切ですよ
コメントアウトに挑戦してみよう
では、恒例となりましたが、今回も学習した内容を実践してみましょう。自分が作ったファイルにそれぞれコメントを入力してみてください
せっかくなので3種類のコメントアウトを全部使ってみましょう
今回は、答えはないの？
そうですね。コメントアウト自体が自由なものなので、とくに答えはありません。自分なりのルールを作ってコメントアウトすればOKですよ
まとめ：まずは自分のためにコメントアウト
というわけで、PHPのコメントアウトの解説はここでおしまいです。二人とも理解できましたか？
今回のは簡単だったかも！
人に伝える前に、まずは自分用のメモとしてコメントアウトする感じですね。数日後の自分に伝わらないのなら、他の人に伝わるはずがありませんから
そのとおりですね。 まずは自分のためのメモとしてなるべくわかりやすくコメントアウトする癖をつけると良いですよ。 やがて、他の人にコードを見てもらうときに必ず役立ちます
