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

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

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

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

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

目次

• コメントアウトとは
• コメントアウトする書き方
• 実際に書いてみよう
• まとめ
• 執筆してくれたメンター
• PHPを学習中の方へ

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

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

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

お願いします！

コメントアウトとは

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

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

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

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

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

1つは「1行でコメントを記述する場合」で、もう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”;では、改行しています。

表示結果

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

コラム

コスパとタイパ、両方結果的に良くなる良くなる学び方とは？

「スクールは高いし時間も縛られて効率が悪い」と考える方は多いと思います。
もちろん、時間も費用もかかることは間違いありません。
ただ 結果的に無駄な学びにお金も時間もかける方がリスクが高いという考えもあります。

コスパ・タイパ最適化の参考として、 テックアカデミー卒業生がスクールを選んだ理由 をご紹介します。

• ・困ったときに、質問や相談できる相手がいるため挫折しなかった
• ・プロとして必要なスキルのみを深く学べたので無駄がなかった
• ・副業案件の提供と納品までのサポートがあったので目的を達成できた

安価・短期間で広く浅く学んでも意味がありません。 本当に自分の目的が達成できるか、それが重要です。
自分にどのスキルや学び方が合っているか、どんな学習方法かなど、お気軽に 無料相談 に参加してみませんか？

カウンセラー・現役のプロへ、何でも気軽に無料相談可能。 30分か60分お好きな時間が選べて、かつ3回まで すべて無料で ご利用できます。
無理な勧誘は一切ない ので、お気軽にご参加ください。

今なら相談した方限定の割引・参加特典付き！ 無料相談はこちら

まとめ

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

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

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

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

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

執筆してくれたメンター

PHPを学習中の方へ

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

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

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

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

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

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

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

プログラミングを独学で学習していて、このように感じた経験はないでしょうか？

• ・調べてもほしい情報が見つからない
• ・独学のスキルが実際の業務で通用するのか不安
• ・目標への学習プランがわからず、迷子になりそう

テックアカデミーでは、このような 学習に不安を抱えている方へ、マンツーマンで相談できる機会を無料で提供 しています。
30分間、オンラインでどんなことでも質問し放題です。

「受けてよかった」と感じていただけるよう カウンセラーやエンジニア・デザイナー があなたの相談に真摯に向き合います。

「自分に合っているか診断してほしい」
「漠然としているが話を聞いてみたい」
こんなささいな悩みでも大丈夫です。

無理な勧誘は一切ありません ので、まずはお気軽にご参加ください。
※体験用のカリキュラムも無料で配布いたします。（1週間限定）

今なら参加者限定の割引特典付き！ 無料相談を予約する