プログラミングにおいて、コメントは重要だ。コメントにして実行されない部分を作ることをコメントアウトという。
このページでは、PHPでのコメントアウトのやり方をお伝えした。本題を早く知りたいという方が多いと思うので、サクサクとお伝えする。
PHP入門者の方は参考にしてほしい。
コメントの書き方
そもそもコメントとは? また、どういうコメントが正しいコメントなのかを知りたい方は先に下のページを読んでみてほしい。
それでは、PHPのコメントについてご紹介していこう。
3種類のコメントアウト
PHPでのコメントの書き方は3パターンある。
//コメント
#コメント
/*コメント*/
「//」「/**/」はC系言語を引き継いでいて、「#」はUnix系のシェルのコメントを引き継いでいる。
使い方はそれぞれ次の通りだ。
1 2 3 4 5 6 7 8 9 10 11 12 13 |
<?php //1行コメントだ #1行コメントだ /*複数行のコメント 複数行のコメント 複数行のコメント 複数行のコメント */ ?> |
- 「//」は1行コメントだ。後ろの文字がコメントになる
- 「#」も1行コメント。後ろの文字がコメントになる
- 「/* */」は複数行のコメントだ。挟まれた部分がコメントになる
このPHPプログラムを実行しても何も表示されない。すべてコメントになっているからだ。
プログラムが長くなってくると、ここで何がしたいんだっけ?と思うことが増えてくる。
そんなときに備え、処理を分かりやすくするためにコメントを残そう。
複数行コメントのよくあるミス
複数行コメントは便利だが、コメントの終了を表す「*/」を忘れてしまうと、本来プログラムとして実行したかった部分までコメントアウトされてしまう。
ページが真っ白で動かないという時には、まず複数行コメントをしっかり閉じているかどうか確認しよう。
まとめ
PHPのコメントアウトの方法をお伝えしたがいかがだっただろうか? プログラミング言語によらない、コメントの書き方やポイントについては下記のページで詳しく説明している。