PHPでウェブの世界と繋がろう!
menu
ホーム > PHPの文法 > 1 基本構造 > 1-5 コメント

1-5 コメント

Pocket

- 1 分ノート ! -

# コメント // コメント
/* コメント */
「/* コメント */」の場合、同じ形式でネスト(入れ子)するとエラーが発生する

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

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

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

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

コメント化する
POINT
  • # コメント
  • // コメント
  • /* コメント*/

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

最初に、「#(シャープ記号)」を使用する方法です。「#」が先頭にあるかぎり行の終わりまでコメントアウトになります。

<?php
# コメント コメント コメント
# コメント コメント コメント
# コメント コメント コメント
?>

次に、「/(スラッシュ記号)」を使用する方法です。「//」 2つのスラッシュを使用します。「//」が先頭にあるかぎり行の終わりまでコメントアウトです。

<?php
// コメント コメント コメント
// コメント コメント コメント
// コメント コメント コメント
?>

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

<?php
/* コメント コメント コメント */
?>

この形では複数行のコメントアウトが可能です。

<?php
/*
コメント
コメント
コメント
*/

/*
for($i=0;$i<=10;$i++){
	echo $i.'<br/>';
}
*/
?>

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

<?php
/*
for($i=0;$i<=10;$i++){
	/* $iを出力します */
	echo $i.'<br/>';
}
*/
?>

また、PHPの終了タグを超えても有効です。

<?php
/*
for($i=0;$i<=10;$i++){
?>
	for文のループ:<?php echo $i; ?><br/>
<?php
}
*/
?>

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

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

<?php
/*
echo 'Hello!'; /* ネストコメント */
*/
?>

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

<?php
/*
echo 'Hello!'; // ネストコメント
*/

/*
echo 'Hello!'; # ネストコメント
*/
?>

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

サンプルコード

– サンプル Click Here ! –

<?php
#シャープ記号「#」が先頭にあるかぎり行の終わりまでコメントアウト
############
#コメント文
############



//2つのスラッシュ「//」が先頭にあるかぎり行の終わりまでコメントアウト
//////////////
//コメント文
//////////////



/*スラッシュとアスタリスク記号で囲んでコメントアウト*/



/*スラッシュとアスタリスク記号で複数行をコメントアウト
※PHPの終了タグを超えても有効
※入れ子はエラーになる。
*/
/*
コメント文
コメント文
コメント文
*/



//コードを一時的に無効にする
/*
for($i=0;$i<=10;$i++){
	echo $i.'<br/>';
}
*/



//PHPの終了タグを超えてコメント化
/*
for($i=0;$i<=10;$i++){
?>
	for文のループ:<?php echo $i; ?><br/>
<?php
}
*/



//コメント化をネストする
/*
echo 'Hello!'; // ネストコメント
*/

/*
echo 'Hello!'; # ネストコメント
*/
?>
実行結果

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


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

日付

投稿日:2011年10月1日
最終更新日:2014年02月01日

関連記事

配列関数サンプル

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

この記事へのコメント

トラックバックurl

http://www.tryphp.net/phpref-comment/trackback/