【PHP】コメントアウトの書き方


PHPの記述の中に、プログラムの説明文や注意文を書くことがあります。

そこで使われるのが『コメントアウト』。

コメントアウトとは?

コメントアウトとは、プログラム中に書き込める注釈のこと。単に「コメント」ともいいます。

コメントアウトは、単なる説明文なので、プログラムの実行には、一切影響を与えません。

プログラムの見出しに使われたり、実行させたくないプログラムを一時的に「読込み不可」にさせることにも利用されます。

コメントアウトを使いこなして、より良いプログラムを書き込んでください。

ここでは、PHPにおけるコメントアウトに関して書いています。HTMLの場合は、別の記述方法になるので、ご注意を。

それでは、以下で『コメントアウトの書き方』をご紹介します。

コメントアウトを書いてみよう

『<?php』と『 ?>』で囲まれたPHP文内でのコメントの書き方には、以下の3通りがあります。

  • //
  • #
  • /*  */
スポンサーリンク

行末までのコメントアウト

最初の2つは、//(2つのスラッシュ)』もしくは『#(シャープ)』以降の行末までの文字列部分がコメントアウトになります

一般的に、『#』よりも『//』の方がよく使われるので、以下では『//』を使ったコメントアウトをご紹介します。

たとえば、例をあげると…

たとえば、PHP文の中に、コメントアウトを入れた場合、以下のようになります。


<?php 
//コメントを挿入 
header(); ?>

<?php header(); //コメントを挿入?>

<?php 
  function add_product_posttype(){ 
    $args = array(//コメントを記述 
      'label' => '商品',
      'public' => true
  );
//コメントを記述
  register_post_type('product', $args);
}
add_action('init','add_product_posttype');//コメントを記述
?>   

やってはいけないパターン

コメントアウトの使用上の注意点としては、コメントアウトの後方には、コードを置かないこと。

コードを書きたい場合は、改行してください

記述方法を間違うと、実行すべきコードまで、コメントアウトしてしまいます。

たとえば、次のように、コメントの後ろにコードを記述すると、半角を空けたとしても(3行目)、改行しない限り、そのすべてがコメントとして扱われ、コードの読み込みがされません。


<?php //コメントを挿入header(); ?>

<?php //コメントを挿入 header(); ?>

この場合、次のように改行すればOK!!コメントの後方には、コードを置かないように。

<?php //コメントを挿入 
header(); ?>

<?php 
//コメントを挿入 
header(); 
?>

でも、次のように、コードの後ろが閉じタグ(?>)であれば問題はありません。

閉じタグは、PHPファイルの中がPHPのプログラムのみで記述されている場合、省略できるため、これがコメントアウトされても、PHPプログラムは実行されます


<?php header();//コメントを挿入?>

スポンサーリンク

複数行をコメントアウトする

//や#では、行が変わると、コメントアウトの効力が無くなってしまいます。

複数行でコメントアウトしたい場合は、『/*(スラッシュ+アスタリスク)』と『*/』を使います

『/*』と『*/』で囲まれた文字列は、複数行をコメントとして認識させることができます。当然ですが、1行の中で囲っても、コメントアウトとして認識してくれます。

また、ひとつのPHP文に複数のコメントアウトを使用することもできます。

入れ子にはできないので、注意が必要!『/*』と『*/』の間に、さらに『/*』『*/』を入れることはできません。

この方法では、以下のように複数行に渡ったコメントを書けます。

<?php
/*
コメントを挿入
*/
header(); ?>

<?php /*コメントを挿入
コメントを挿入
*/header(); ?>

<?php /*
コメントを挿入
コメントを挿入/*
header(); ?>

<?php 
/*
コメントを挿入
コメントを挿入
/*
/*
コメントを挿入
コメントを挿入
/*
header(); ?>

<?php
/*コメントを挿入*/
header(); ?>

<?php /*コメントを挿入*/header(); ?>

複数のコメントアウトを使うことも可能

『//』や『#』、『/* */』を複数使用することもできます。

たとえば、次のように。

<?php /*
コメントを挿入
コメントを挿入
/*
//コメントを挿入
#コメントを挿入
header();/*コメントを挿入*/?>
スポンサーリンク
ページ先頭へ