覚えておくと便利!PHPでコメントアウトする書き方【初心者向け】

プログラミング初心者向けにPHPで書くコメントアウトの書き方を解説しています。一行の時と複数行の時で書き方が少し違いますが、誰でも簡単に覚えられるはずです。複数人での開発作業でよく使うので、ぜひ書いてみてください。

TechAcademyマガジンはオンラインのプログラミングスクールTechAcademy [テックアカデミー]が運営する教育×テクノロジーのWebメディアです。初心者でもすぐ勉強できる記事が2,000以上あります。

PHPでコメントアウトをする書き方について解説しています。

複数人で作業をする際は他の人が見ても分かるようにコメントを書いておくことが多いでしょう。また、作業中にあとで必要になるかもしれないソースコードはコメントアウトするはずです。

今回は、PHPでその書き方を紹介しているので、ぜひ覚えておきましょう。

 

なお本記事は、TechAcademyのPHPオンライン講座の内容をもとにしています。

 

今回の記事の内容は動画でもご覧いただけます。
テキストよりも動画の方が理解しやすいという場合はぜひご覧ください。

 

大石ゆかり

田島メンター!コメントアウトってどうやって書いたらいいんですか〜?

田島悠介

とても簡単だけど一行の時と複数行の時で書き方がちょっと違うから書きながら見ていこうか!

大石ゆかり

お願いします!

 

コメントアウトとは

コメントアウトとは、どのようなプログラムかをわかりやすくするために書いておくことをいいます。

ソースコード上に書いてもコンパイル時や実行時には無視されます。そのため、あくまでも人が読んで「この部分はこういう風に動作するのか」といった情報を共有するために記述します。

 

コメントアウトする書き方

PHPでのコメントアウトの書き方は2つあります。一つは「1行でコメントを記述する場合」で、もう一つは「複数行でコメントを記述する場合」です。

 

1行でコメントを書く場合は

// 1行コメントはこのように書きます。

のように、// を先頭に記述してその後にコメントを書くことでコメントアウトできます。

 

複数行でコメントを書く場合は、

/*
複数行でコメントを
書く場合は、このように
書きます。
*/

のように、/* と */ の間にコメント文を書くことでコメントアウトできます。

 

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

実際に書いてみよう

それでは実際にプログラムを書いてみましょう。関数を2つ定義して、それがどのように動作するかを記述します。

comment_out.php
----------------------------------------
<?php
// 数値を2ついれて、その和を出力する関数
function add($x, $y){
  /*
  引数:
    x: int型
    y: int型
  出力:
    int型
   */
  // xとyを足して、zに代入する
  $z = $x + $y;
  return $z;
}
// 数値を2ついれて、その差を出力する関数
function sub($x, $y){
   /*
   引数:
     x: int型
     y: int型
   出力:
     int型
   */
  // xからyを引き、zに代入する
  $z = $x - $y;
  return $z;
}
// add関数を実行して表示する
echo add(1, 3);
echo "\n";
// sub関数を実行して表示する
echo sub(100, 10);
echo "\n";
?>
----------------------------------------

 

以下、実行結果です。

----------------------------------------
4
90
----------------------------------------

コメントアウトしている行は一切表示されていないことがわかります。

 

まとめ

コメントアウトはプログラムの規模が大きくなるにつれて、書いておくこと、そして書き方がとても重要になってきます。

ぱっと見なんのソースコードかを分かる必要があるため書いておくことは大事ですが、書きすぎると今度は直感性に欠け、逆にソースコードを読んだほうがわかりやすいことにもなります。

一人でプログラムを書く場合や複数人でプログラムを書く場合など、状況に応じてどのようなコメントを残し方を決めておくと良いでしょう。

 

田島悠介

使うエディタによるかもしれないけど、「command」+「/」でコメントアウトできるから覚えておくと便利だよ!

大石ゆかり

おお〜!ショートカットですね!ありがとうございます^^

 

また、PHPを勉強していて、

  • もっと効率的に勉強したい
  • 誰かに聞きながら学びたい
  • 自分でWebサービスを作りたい

と思ったことはないでしょうか。

 

そんな方のために、TechAcademyではオンラインブートキャンプPHP/Laravelコースを提供しています。

現役エンジニアがパーソナルメンターとして受講生に1人ずつつき、マンツーマンのメンタリングで学習をサポートし、最短4週間でオリジナルWebサービスを開発することが可能です。

独学に限界を感じている場合はご検討ください。