今回はPHPで使用するコメント機能です。 通常のプログラミング言語で使用するコメント機能とほぼ同じように使用することができます。 コメント機能の概要を知りたい方はこちら

PHPのコメント

3年以内に更新されました。情報が古い可能性があります。
更新日 : 2019年02月26日

今回はPHPで使用するコメント機能です。

通常のプログラミング言語で使用するコメント機能とほぼ同じように使用することができます。

コメント機能の概要を知りたい方はこちら

コメントの書き方

PHPのコメントの書き方は一般的なプログラミング言語で使われる記述方法と同じです。

以下のコードを見てみましょう。

<?php
	echo "表示されます。<br>";
	// echo "この1行は表示されません。";

	/*
	echo "このエリアはすべて表示されません。";

	このエリアには好きなようにコメントを書くことができます。
	PHPのコードを入れてもなにも反映されず、エラーが起こることはありません。

	echo "このエリアはすべて表示されません。";
	*/
	echo "コメントエリアから外れたため、表示されます。";
?>

こちらのコードで実際に実行される部分はどこでしょう?実際にこのコードを実行した結果が下の画像です。

実際に表示されるのは最初の行と最後の行のみです。

1行のみコメント

1行のみコメントを書きたい場合は//と記述します。最初に//と記述することによって、その行はPHPのコードが実行されません。

上記のコードでは// echo "この1行は表示されません。"; の部分ですね。

複数行をコメント

複数行コメントアウトする場合は/*〜*/と記述します。
このエリアは、改行を行っていてもコメントとして扱われ、PHPのコードは実行されません。

上記のコードでは

/*
	echo "このエリアはすべて表示されません。";

	このエリアには好きなようにコメントを書くことができます。
	PHPのコードを入れてもなにも反映されず、エラーが起こることはありません。


	echo "このエリアはすべて表示されません。";
	*/

この部分になります。

エラーとなるコメント

以下のコードはエラーとなります。

<?php
	/*
		コメント欄で唯一書いてはいけないものが、
		コメント内部でのコメントです。
		↓これはエラーになります。どこまでがコメントかを判別できません。
		/*  */
	*/
?>

コードに書いたとおり、複数行のコメント内部に複数行のコメント記述を行うと、実行する際に、実際にどこまでがコメントエリアかわからなくなるため、エラーとなり実行できません。

そもそもこのような状況はあまりないので特に気にする必要は無いかと思います。

まとめ

今回はPHPのコメントについて書きました。プログラミングを始めたばかりの方はコメントの利用価値がわからない場合もありますが、実際に長いコードを書いていくと必要になってくることがあります。

コメントを利用した詳細設計書の生成などに使用されることもあるので、徐々に慣れていただければと思います。