PHPのプログラムの中でコメントを記述する

プログラムを記述していく上で、この部分はどんな目的でプログラムを記述していたかなどのコメントを残しておくとあとからメンテナンスを行う上で役に立ちます。コメントは PHP プログラムが実行される際に無視されますのでプログラムの出力結果などには影響しません。ここでは PHP でコメントを記述する方法について解説します。

(2021 年 06 月 30 日公開 / 2022 年 10 月 27 日更新)

「#」を使ったコメント

PHP のプログラムの中でコメントを記述する最初の方法は、 # を使用する方法です。次のように記述します。 

#コメント

プログラム中に # が現れた場合、 # から行末または終了タグの ?> までをコメントとして扱います。 # は文の先頭に記述しその行を全てコメントとしてもいいですし、文の途中で記述してその位置より右側をコメントとしてもいいです。 

<?php
# 作成日 2022/10/27

echo "こんにちは";   # あいさつを出力
?>

コメントはプログラムの実行時には無視されますので次のように記述したものと同じと解釈されます。 

<?php
echo "こんにちは";
?>

「//」を使ったコメント

PHP のプログラムの中でコメントを記述する 2 つ目の方法は、 // を使用する方法です。次のように記述します。 

//コメント

# の代わりに // を使用しているだけで使い方は同じです。 // は C++ 言語でコメントを記述する場合の書式です。

例えば次のように記述します。 

<?php
// 作成日 2022/10/27

echo "こんにちは";   // あいさつを出力
?>

「/*」と「*/」を使ったコメント

PHP のプログラムの中でコメントを記述する 3 つ目の方法は、 /* と */ を使用する方法です。次のように記述します。 

/* 
コメント
コメント
 */

プログラムの中で /* が現れた場合、 */ が現れるまですべてコメントとして扱います。そのため、複数行をまとめてコメントにすることもできます。

例えば次のように記述します。 

<?php
/* 作成日 2022/10/27 */

echo "こんにちは";   /* あいさつを出力 */
?>

このように # や // と同じような使い方もできますが、この書式の場合は行末までがコメントではなく */ が現れるまでがコメントとなるため複数行に渡ったブロックをまとめてコメントとすることが可能です。例えば次のように使います。 

<?php
/* 
  作成日 2022/10/27
  作成者 山田 太郎
  開発環境 PHP 8.x
*/

echo "こんにちは";
?>

上記の場合 /* から */ までに含まれる全ての部分がコメントとなります。

いずれの方法であってもコメントとしての意味は同じですので使いやすいものを統一して使用されると宜しいのではないかと思います。

サンプルコード

では簡単なプログラムで試して見ます。 

<!DOCTYPE html>
<html lang="ja">
<head>
<meta charset="UTF-8">
<title>PHPテスト</title>
</head>
<body>

<p>
<?php
/* 作成日 2022/10/27
   作成者 hogehoge
   Version 3.5 */

echo "こんにちは。";  # 画面に出力
?>
</p>

</body>
</html>

上記を sample.php として Web サーバのドキュメントルートに設置したあと、ブラウザから Web サーバの先ほどのファイルへアクセスしてください。次のように表示されます。

PHPのプログラムの中でコメントを記述する(1)

今回は /* と */ を使ったブロック単位のコメントと、 # を使って文の最後にコメントを記述しました。コメントは実行時には無視されますのでコメントをどれだけ記述しても実行結果には影響を与えません。

-- --

PHP でコメントを記述する方法について解説します。

( Written by Tatsuo Ikura )

Profile
profile_img

著者 / TATSUO IKURA

プログラミングや開発環境構築の解説サイトを運営しています。

カテゴリ