menu
ホーム > PHPの文法 > 1 基本構造 > PHP の コメント 一行・複数行のコメントアウト
UPDATE:2017年09月27日

PHP の コメント 一行・複数行のコメントアウト

PHPリファレンス

PHP5 PHP7

1 Minute Note

  • # コメント
  • // コメント
  • /* 複数行コメント
    複数行コメント */
    ※「/* コメント */」の場合、同じ形式でネスト(入れ子)するとエラーが発生する
PHPのコード中にコメントを挿入するには、# コメント// コメント/* コメント */ 、 の3種類があります。


コメントとは

  • コメントはプログラムコード中の注釈

コメントとはプログラムコード中における注釈のようなものです。HTMLで表現すると「<!– コメント –>」に相当します。PHPはコメント化(コメントアウト)された部分を無視します。コメント化された部分はプログラムとは関係なく自由に記述することができます。

プログラムコードを記述する場合、必要な箇所に適度なコメントを書き記しておくことは大切なことです。コードを記述しているときはその内容を把握していても、後で読み返してみて記述した本人が分からなくなってしまうことがあります。そのようなときにコメントが役立ちます。適切なコメントを付ける癖を付けておきましょう。

また、プログラムのソースコードを部分的に修正する場合に、消したい内容を実際に消してしまうのではなく、コメント化することで一時的に機能しないようにします。そうすることで、必要に応じて、コメント化記号を外すだけで、再度コードを実行することができます。


コメント化(コメントアウト)する

  • # コメント
  • // コメント
  • /* 複数行コメント
    複数行コメント */

コメント化するには3種類の方法があります。


# (シャープ記号)でコメントアウト

最初に、「#(シャープ記号)」を使用する方法です。これは、単一行用のコメントです。「#」が先頭にあるかぎり行の終わりまでコメントアウトになります。PHPは # から行の終わりまでのコードを無視します。改行または、PHP終了タグ「?>」が出るまでコメント化が続きます。それ以降はコメント化が解除されて、コードが実行表示されるようになります。

結果は

こんにちは!
HTMLです。

となります。コメント部分は表示されません。


// (スラッシュ記号)でコメントアウト

次に、「/(スラッシュ記号)」を使用する方法です。「//」 2つのスラッシュを使用します。「//」が先頭にあるかぎり行の終わりまでコメントアウトです。PHPは // から行の終わりまでのコードを無視します。改行または、PHP終了タグ「?>」が出るまでコメント化が続きます。それ以降はコメント化が解除されて、コードが実行表示されるようになります。

結果は

こんにちは!
HTMLです。

となります。コメント部分は表示されません。


/* */ でコメントアウト

3つ目は、「/(スラッシュ記号)」と「*(アスタリスク記号)」で囲み、コメントアウトします。「/*」から始まり、「*/」で閉じるところまでがコメントアウトです。

結果は

こんにちは!

となります。コメント部分は表示されません。

# や // は単一行用のコメントであるのに対して、この形では複数行のコメントアウトが可能です。

実行しても何も表示されません。


/* */ の入れ子エラー

以下のように /* */ で作るコメントアウトを入れ子にするとエラーになります。注意してください。


PHP終了タグを超えてコメントアウト

/* */ で作るコメントは、PHPの終了タグ ?> を超えても有効です。


コメントの注意点

  • /* コメント */」この形式の場合、同じ形式を使用したコメント化をネスト(入れ子)するとエラーが発生する

「/(スラッシュ)」と「*(アスタリスク)」を使用したコメント化「/* コメント */」の場合、同じ形でコメントアウトをネスト(入れ子)してはいけません。

この場合、パースエラーが発生してしまいます。
ネストする場合は、 「/(スラッシュ)」か「#(シャープ)」を使用したコメント化を利用しましょう。

このようにすればエラーは発生しません。


サンプルコード

– サンプル Click Here ! –

実行結果

何も表示されません。
– サンプル Click Here ! –


タグ(=記事関連ワード)

日付

公開日:2017年8月28日
最終更新日:2017年09月27日

関連記事

配列関数サンプル

このカテゴリの他のページ

この記事へのコメント

トラックバックurl

http://wepicks.net/phpref-comment/trackback/

page top