プログラミングや動画編集の勉強ならCANIT (キャニット)

PHP基礎編3:コメントアウトをキッチリできるのが優秀なプログラマー

PHP入門
CANIT先生
CANIT先生

今回の講義ではコメントアウトについて学んでいきましょう。 実は「優秀なプログラマーはコメントアウトが上手」と、コメントアウトはプログラマーの力量を測るポイントにもなっています

猫田さん
猫田さん

なんと! それなら頑張って覚えますよー。 わたしは、優秀だと思われたくて仕方ありません

牛山くん
牛山くん

ところで、コメントアウトってなんですか? なんとなく想像はつきますけど……

CANIT先生
CANIT先生

そうですね。では、まずコメントアウトの説明からいきましょうか

PHPの学習:コメントアウトはどんな機能?

HTML
CANIT先生
CANIT先生

コメントアウトとは、「プログラムの中にコメントを残す機能」を指します。 言い換えればメモ書きのようなものですね

牛山くん
牛山くん

なんとなくそんな気はしました。 どんな目的で使うんですか?

コメントアウトを使うとコードがわかりやすくなる

最大の目的は、コードをわかりやすくすることです。

とくに複数人でプログラミングをするときには、他の人たちに「こんなコードを書いたよ」とコメントアウトで伝える必要があります。チームで作業をする際には、コメントアウトが必須ですよ。

猫田さん
猫田さん

そっか。 人の書いたコードの意味がわからないと、仕事にも影響が出るもんね

もちろん、自分用のメモとしてコメントアウトをするケースも多いです。

今はチームで仕事をしていなくても、将来的にはコメントアウトが必要になる可能性が高いです。今のうちからコメントアウトする癖をつけておきましょう。

上手なコメントアウトのやり方とは

牛山くん
牛山くん

さっき「上手なコメントアウト」と言ってましたが、コメントアウトに上手いとか下手とかあるんですか?

CANIT先生
CANIT先生

簡単に言うと、伝えるべき箇所を伝えている人が、上手にコメントアウトできる人です。なんでもかんでも伝えればいいというものでもありません

猫田さん
猫田さん

わかるー 話が長いおじさんは嫌われるよね

コメントアウトはやりすぎないのがコツです。 たとえば、以下の画像を見てください。緑の文字がコメントアウトされた箇所です。

牛山くん
牛山くん

なんか……とても多いですね

猫田さん
猫田さん

話が長いおじさんだねぇ

これは全ての処理に対してコメントアウトを記載しているパターンですね。

コメントアウトの練習ならこれでも良いのですが、実際にプログラミングの現場でここまでコメントアウトをしていたら、莫大な時間がかかってしまいます。

もっと内容を簡潔にまとめてコメントアウトしましょう。

CANIT先生
CANIT先生

では、こちらのコメントアウトはいかがですか?

牛山くん
牛山くん

さっきよりもだいぶコメントの量が減っていますね。でも、何が書かれているのかは、きちんとわかります

CANIT先生
CANIT先生

そうですね。 だから、こっちのコメントアウトのほうが一緒に働いている人たちからは好まれやすいんですよ。 コメントアウトにかかる時間も大幅に短縮できます

コメントアウトは基本、自由

コメントアウトの目的は、どのような処理をしているのかを分かりやすくすることです。だから、極論を言えば担当者が理解できれば、どんな内容でも構いません

たとえば、「なぜかは分かりませんが、この行を消すとエラーが出ます」、「ここの処理は実装には関係ないと思われます」のようなコメントアウトでもOKです。

コメントアウトは、自分もしくは自分以外の誰かに宛てたメッセージなので、深く考えず自由に書いてください。

PHP学習:3種類のコメントアウト方法

プログラマー
CANIT先生
CANIT先生

続いて、コメントアウトのやり方を紹介しますね。PHPでは下記の3つの方法でコメントアウトをします

  1. 行頭に「//」を入力する(入力した行がコメントアウトの範囲)
  2. 行頭に「#」を入力する(入力した行がコメントアウトの範囲)
  3. コメントの範囲を「/*」と「*/」で囲む(囲んだ範囲がコメントアウトの範囲)

この3つのやり方を使い分けるのが、上手なコメントアウトをするポイントです。

CANIT先生
CANIT先生

基本的には自分のやりたいように使い分ければ良いのですが、少しだけ実例を紹介しましょう

①:「//」は単行のコメントアウトにオススメ

今回のような処理が少ないプログラミングの場合は、それほど使う機会がありませんが、「//」でコメントアウトをする場合は単行での処理を入力するのにオススメです。

1行で処理が完了する場合、その行でどのような処理をしているのかをメモ書きしておくために「//」のコメントアウトを使用します。

②:「#」はその部分の処理で何をしているのかを記入する

あくまでも一例ですが、「//」との使い分けとして「複数行のプログラミングの上部に「#」でコメントアウトする」方法があります。

echoで配列の中身を出力していますが、複数行のプログラミングをしています。その部分をまとめて「#」でコメントアウトする方法です。

牛山くん
牛山くん

「//」が一行で、「#」が複数行ですね。 これは、なかなかわかりやすいと思います

③:「/**/」では、まとめて記入しておきたいことをコメントするのにオススメ

最後に「/**/」でのコメントアウトです。これは、全体をまとめてメモ書きしておくのにオススメです。

今回のケースだと、このようになります。

このようにどのような処理をしているのかを長文で残したいときには「/**/」を使用したほうが分かりやすくなります。

CANIT先生
CANIT先生

ただ、あくまでも今回紹介した使い方は一例なので、自分にとって分かりやすい方法でコメントアウトしてください。自分なりのルールを作るのが大切ですよ

コメントアウトに挑戦してみよう

パソコン
CANIT先生
CANIT先生

では、恒例となりましたが、今回も学習した内容を実践してみましょう。自分が作ったファイルにそれぞれコメントを入力してみてください

牛山くん
牛山くん

せっかくなので3種類のコメントアウトを全部使ってみましょう

猫田さん
猫田さん

今回は、答えはないの?

CANIT先生
CANIT先生

そうですね。コメントアウト自体が自由なものなので、とくに答えはありません。自分なりのルールを作ってコメントアウトすればOKですよ

まとめ:まずは自分のためにコメントアウト

パソコン
CANIT先生
CANIT先生

というわけで、PHPのコメントアウトの解説はここでおしまいです。二人とも理解できましたか?

猫田さん
猫田さん

今回のは簡単だったかも!

牛山くん
牛山くん

人に伝える前に、まずは自分用のメモとしてコメントアウトする感じですね。数日後の自分に伝わらないのなら、他の人に伝わるはずがありませんから

CANIT先生
CANIT先生

そのとおりですね。 まずは自分のためのメモとしてなるべくわかりやすくコメントアウトする癖をつけると良いですよ。 やがて、他の人にコードを見てもらうときに必ず役立ちます

❤内容は役に立ちましたか?皆さまのご意見が励みになります☺
YesNo
手に職をつけてプログラマー転職

そろそろ本気で将来のことを考えなくちゃ……手に職をつけてプログラマーやエンジニアに転職したいなぁ。でも、プログラミングスクールってものすごくたくさんあるし、なんか敷居が高いのよね

これからプログラマーやエンジニアへの転身を目指すあなたに、どのスクールがもっとも適しているのかを紹介します。

PHP入門
【この記事を書いた人】
CANIT 先生

あらゆるプログラミング言語をあやつるフリーの凄腕講師。温和な性格で「わかるまで教えます」がモットー。たまに時間ができると動物の仲間達に、プログラミングを教えることもある。現在の生徒は牛山くんと猫田さん。

CANIT
タイトルとURLをコピーしました