覚えておくと便利!PHPでコメントアウトする書き方【初心者向け】現役エンジニアが解説

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

TechAcademyマガジンは受講者数No.1のオンラインプログラミングスクールTechAcademy [テックアカデミー]が運営。初心者向けに解説した記事を公開中。現役エンジニアの方はこちらをご覧ください。

監修してくれたメンター

nakamoto

アジマッチ有限会社 代表取締役
対応業務:PHP(Laravel)、機械学習、Vue.js、LAMP・AWS、越境EC、スマホアプリ、Unity、Rails、スマートコントラクト、講師、執筆、CTO

PHPでコメントアウトをする書き方について、テックアカデミーのメンター(現役エンジニア)が実際のコードを使用して初心者向けに解説します。

複数人で作業をする際は他の人が見ても分かるようにコメントを書いておくことが多いでしょう。

また、作業中にあとで必要になるかもしれないソースコードはコメントアウトするはずです。

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

目次

そもそもPHPについてよく分からないという方は、PHPとは何なのか解説した記事を読むとさらに理解が深まります。

大石ゆかり

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

田島悠介

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

大石ゆかり

お願いします!

 

コメントアウトとは

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

ソースコード上に書いてもコンパイル時や実行時には無視されます。

そのため、あくまでも人が読んで「この部分はこういう風に動作するのか」といった情報を共有するために記述します。

 

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

PHPでのコメントアウトの書き方は2つあります。

一つは「1行でコメントを記述する場合」で、もう一つは「複数行でコメントを記述する場合」です。

 

1行でコメントを書く場合は以下のコードです。

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

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

 

複数行でコメントを書く場合は以下のコードです。

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

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

 

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

実際に書いてみよう

それでは実際にプログラムを書いてみましょう。

関数を2つ定義して、それがどのように動作するかを記述します。

<?php
// 数値を2ついれて、その和を出力する関数
function add($x, $y){
    /*
    変数$addに
    $xと$yを足した
    合計を代入する
    */
    $add=$x+$y;
    // 変数$addを返す
    return $add;
}
// 数値を2ついれて、その差を出力する関数
function sub($x, $y){
    /*
    変数$sub
    $xから$yを引いた結果を
    代入する
    */
    $sub=$x-$y;
    // 変数$addを返す
    return $sub;
}
// add関数を実行して表示する
echo add(1, 3);
// 改行する
echo "\n";
// sub関数を実行して表示する
echo sub(100, 10);
// 改行する
echo "\n";

解説

<?phpでは、phpプログラムを開始することを意味します。

// 数値を2ついれて、その和を出力する関数は、1行コメントです。この内容は実行結果に表示されません。

function add($x, $y){では、関数addを宣言しています。

/*では、複数行コメントを開始することを意味します。この内容は実行結果に表示されません。

変数$addは、複数行コメントの一部です。この内容は実行結果に表示されません。

$xと$yを足したは、複数行コメントの一部です。この内容は実行結果に表示されません。

合計を代入するは、複数行コメントの一部です。この内容は実行結果に表示されません。

*/では、複数行コメントを終了することを意味します。この内容は実行結果に表示されません。

$add=$x+$y;では、変数xとyを足した結果を変数addに代入しています。

// 変数$addを返すは、1行コメントです。この内容は実行結果に表示されません。

return $add;では、変数addを返しています。

}では、関数addを終了しています。

// 数値を2ついれて、その差を出力する関数は、1行コメントです。この内容は実行結果に表示されません。

function sub($x, $y){では、関数subを宣言しています。

/*では、複数行コメントを開始することを意味します。この内容は実行結果に表示されません。

変数$subは、複数行コメントの一部です。この内容は実行結果に表示されません。

$xから$yを引いた結果をは、複数行コメントの一部です。この内容は実行結果に表示されません。

代入するは、複数行コメントの一部です。この内容は実行結果に表示されません。

*/では、複数行コメントを終了することを意味します。この内容は実行結果に表示されません。

$sub=$x-$y;では、変数xからyを引いた結果を変数subに代入しています。

// 変数$addを返すは、複数行コメントの一部です。この内容は実行結果に表示されません。

return $sub;では、変数subを返しています。

}では、関数addを終了しています。

// add関数を実行して表示するは、複数行コメントの一部です。この内容は実行結果に表示されません。

echo add(1, 3);では、関数addに引数1と3を指定して実行しています。

1+3の結果である4が返ってきて、表示されます。

// 改行するは、複数行コメントの一部です。この内容は実行結果に表示されません。

echo “\n”;では、改行しています。

// sub関数を実行して表示するは、複数行コメントの一部です。この内容は実行結果に表示されません。

echo sub(100, 10);では、関数subに引数100と10を指定して実行しています。

100-10の結果である90が返ってきて、表示されます。

// 改行するは、複数行コメントの一部です。この内容は実行結果に表示されません。

echo “\n”;では、改行しています。

 

表示結果

 

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

 

まとめ

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

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

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

 

田島悠介

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

大石ゆかり

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

この記事を監修してくれた方

中本賢吾(なかもとけんご)
アジマッチ有限会社 代表取締役社長

開発実績:PHPフレームワークによるフランチャイズ企業向け会員制SNS。Shopifyによる海外進出用大規模ネットショップ構築。Vue.jsによる金融機関向け内部アプリ。AWSやLinuxハウジングサーバーでの環境構築。人工知能を利用した画像判別システム。小売チェーン店舗用スマホアプリ。Wordpressによる不動産チェーン店向け賃貸・売買仲介システム。基幹システム移管用データコンバートシステム。小学生がUnityでオリジナルAndroidアプリをGooglePlayでリリース、NHK Whyプログラミング入賞、全国Programing Festival入賞、中学生がノーコードでSNS型PWAアプリリリースなど、ボランティアプログラミング教育活動行っている。

 

PHPを学習中の方へ

これで解説は終了です、お疲れさまでした。

  • つまずかず「効率的に」学びたい
  • 副業や転職後の「現場で使える」知識やスキルを身につけたい

プログラミングを学習していて、このように思ったことはありませんか?

テックアカデミーのPHP/Laravelコースでは、第一線で活躍する「プロのエンジニア」が教えているので、効率的に実践的なスキルを完全オンラインでしっかり習得できます。

合格率10%の選考を通過した、選ばれたエンジニアの手厚いサポートを受けながら、PHP/Laravelを使ったWebアプリケーション開発を学べます。

まずは一度、無料体験で学習の悩みや今後のキャリアについて話してみて、「現役エンジニアから教わること」を実感してみてください。

時間がない方、深く知ってから体験してみたい方は、今スグ見られる説明動画から先に視聴することをおすすめします!