PHPのコメント・コメントアウト
プログラミング言語には必ずあるコメント機能。
ソースコードに命令以外のメモやコメントなどを記述したり、いったん無効にしたい命令文などにコメント機能を使います。
自分で書いたソースも時間がたつと「これってどんな意図だっけ?」となることも多いと思います。自分はもちろん他人一緒に作業することが多いと思うので、何かロジックを書く際は意図や目的を意識したコメントを多めに書いていくよう心がけましょう。
このページではコメント機能の使い方を紹介していきます。
1行だけコメントアウト
1行だけコメントアウトしたいときは命令の前に
//
#
を付けます。
両方まったく同じ機能ですが、現在では#よりも//を使う風習になっていますので、それに習った方が無難です。
<?php
//単一行コメントその①
#単一行コメントその②
?>
複数行をコメントアウト
複数行をコメントアウトしたいときは /* */で囲みます。
<?php
/*
複数行をコメントする
複数行をコメントする
複数行をコメントする
*/
?>
行の途中~行末をコメントアウト
行頭だけでなく行の途中から行末までコメントアウトすることもできます。
その行の説明などを付加するときなどによく使われます。
<?php
print "①"; //1つめの出力
print "②"; //2つめの出力
print "③"; //3つめの出力
?>
応用 ~こんな場合はどうなる?
複数行コメントの中の単一行コメント
複数行コメント /* */の中に単一行コメントの //や#を使う。
→コメント機能として有効です
<?php
/*
# 複数行をコメントする
// 複数行をコメントする
// 複数行をコメントする
*/
?>
複数行コメントを単一行コメントで覆う
複数行のコメントで覆われた文の行に #や//を使う。
→コメント機能として有効です
<?php
// /*
// 複数行をコメントする
// 複数行をコメントする
// 複数行をコメントする
// */
?>
1行に複数書いた命令にコメントを使う
例として以下のような1行に複数命令を書いた場合にコメントを使ってみます。
<?php
print "①"; print "②"; print "③";
?>
→①②③と表示されます。
これにコメントを使います。
例1)
<?php
//print "①"; print "②"; print "③";
?>
→何も表示されません!!!!!!!!!!!!
コメントはあくまで行全体に適用されます。要注意です!!
ちょっとしたことでバグにつながりかねないので、命令文は1行に1つにしたほうがよさそうです。
例2)
<?php
print "①"; print "②"; //print "③";
?>
→①②だけ表示されます。
コメント