php コメントアウト

デザイン五輪書

デキる人程活用している!PHPのコメントアウト機能

読了までの目安時間:約 13分

 

にほんブログ村 イラストブログ Photoshopへコンピュータグラフィックス ブログランキングへFC2ブログランキングブログランキングならblogram i2iブログランキング

デキる人程活用している!PHPのコメントアウト機能

コメントアウトとは?

メモ書きとして役立つコメントタグ

PHPを使用してサイト上に複数のプログラムを組んでいると、何処から何処までがどのプログラムのソースコードなのかが分かり辛くなって来ます。
後からソースコードを見返す機会があった際、目的のプログラムのソースコードを探す為に、頭からソースコードを追って行かなければならなくなってしまいます。
これが結構、大変な労力となります。

該当ソースコードを探す

そこで、ソースコードにメモ書きを残し、このプログラムが何なのかを書き記す事が出来ます。
その際に使用するのがコメントタグです。
コメントタグが、いわゆる、目印としての役割を持つ訳です。

コメントタグを使用すると、該当場所はPHPとして処理をされません。
ですから、メモ書きとして使用出来る訳です。
このように、コメントタグによって部分的にソースコードを無効化させる事をコメントアウトと言います。

▲もくじへ戻る

PHPでコメントアウトを行う方法

一行のみに対して行うコメントアウト

PHPにメモ書きを書き加える場合、「/」を二回書き加える方法でコメントアウトを行います。
「//」を記述すると、その右側部分はコメントアウトされ、PHPとして処理されません。

<?php
$a = "コメントアウト";
echo $a;//コメントアウトと表示される
?>

「//」でコメントアウトされる範囲は一行のみですから、次の行のPHPからは処理されます。

<?php
$a = "コメントアウト";
//コメントアウトと表示される
echo $a;
?>

▲もくじへ戻る

一行のみに対して行う、もう一つのコメントアウト

PHP内の一行部分に対して行うコメントアウトには、もう一つの方法があります。
それは、「#」を記述する方法です。
「#」を記述した右側部分はコメントアウトされ、PHPとして処理されません。

<?php
$a = "コメントアウト";
echo $a;#コメントアウトと表示される
?>

使い方は「//」と同じですが、実は、「#」を使用したコメントアウト方法は、推奨されている方法ではありません。
結果的には「//」と同じ結果を得る事が出来ますが、使用しない方が無難です。

ですから、何かしら事情が無い限りは、「#」ではなく、「//」を使用するようにしましょう。

▲もくじへ戻る

複数行に対して行うコメントアウト

「//」は一行のみに対して行うコメントアウトでしたが、複数行に渡ってコメントアウトを行う場合は、「/∗」と「∗/」で対象部分を囲みます。
「/∗」と「∗/」で囲まれた部分はコメントアウトされ、PHPとしては処理されません。

<?php
echo "こんにちは!";
/*
$a = date("Y/m/d");
echo "今日の日付は" .$a ."です。";
*/
?>

以下のようにメモ書きとしても使用出来ますが、どちらかと言えば、PHPのプログラムの一部の働きを停止させる目的で使用する方が適しています。

<?php
$a = "コメントアウト";
/*コメントアウトと表示される*/
echo $a;
?>

▲もくじへ戻る

コメントアウトのよくある失敗例

コメントタグは入れ子に出来無い!

PHP内で、「/∗」と「∗/」で囲まれた部分はコメントアウトされるとご紹介しました。
そう聞くと、普通のタグみたいに「/∗」と「∗/」を入れ子に出来そうなイメージを持ってしまいますが、コメントタグの場合、同じコメントタグで入れ子にする事は出来ません。

<?php
/*
$a = "コメントアウト";
/*コメントアウトと表示される*/
echo $a;
*/
?>

上記のように記述すると、最後の「∗/」の部分がエラーを引き起こしてしまいます。

ちなみに、「//」が「/∗」と「∗/」の間に挟まれるケースの場合は、エラーにはなりません。

<?php
/*
$a = "コメントアウト";
echo $a;//コメントアウトと表示される
*/
?>

▲もくじへ戻る

PHPとHTMLとではコメントタグが異なる

今回ご紹介している種類のコメントタグは、PHPで使用するものです。
ですから、使用場所はPHPのプログラム内に限られます。

従って、「<?php」と「?>」との間でしか使用する事が出来ません。
そこを理解せずに使用しても、思った結果を得る事は出来ません。

/*
<p>今回のテーマは
<?php
$a = "コメントアウト";
echo $a;
?>
です。</p>
*/

上記ケースの場合は、「/∗」と「∗/」を使用するのではなく、HTML用のコメントタグ、「<!--」と「-->」を使用します。

<!--
<p>今回のテーマは
<?php
$a = "コメントアウト";
echo $a;
?>
です。</p>
-->

PHPのechoと言う命令で出力される文字もHTML扱いされますので、結果的には、HTML用のコメントタグによってコメントアウトされます。

▲もくじへ戻る

コメントアウトの活用法

目印としてコメントアウトを活用する

前述しましたが、コメントアウトを目印として活用する事で、後々にメンテナンスを行う際、目的のPHPプログラムのソースコードが探し易くなります。

更に、ほとんどのエディタソフトには検索機能が付いています。
コメントアウトしたPHPはブラウザ上で確認する事が出来ませんが、エディタ上ではきちんと表示されます。
従って、コメントアウトした部分の文字はエディタソフトで検索出来るので、より簡単に、目的のPHPプログラムのソースコードへ移動する事が可能なのです。

コメントアウト部分をエディタソフトで検索

その際、コメントアウトする部分に、検索を意識した文字を記入しておく必要があります。

更に、第三者がソースコードに手を加える際も、コメントアウトの目印があると役に立ちます。
購入したテンプレートに目印用のコメントアウトが入っていれば、製作者の親切さを感じます。
一方で、これが無いと、テンプレート製作者に対して、使用者への配慮の無さを感じてしまいます。

▲もくじへ戻る

プログラムを停止させる目的でコメントアウトを行う

サイト内で不具合が起こっている際、不具合部分を特定するのは大変です。
その際に役に立つのがコメントアウトの機能です。

コメントアウトを行うと、その部分はPHPのプログラムとして処理されません。
従って、PHP内の範囲を順番にコメントアウトして範囲を絞って行けば、不具合を起こす原因となっている場所を特定する事が出来るのです。

コメントアウト部分は簡単に復旧出来ますので、必要な部分を削除してしまう恐れもありません。

また、自分以外の人物が作成したテンプレートをカスタマイズする際、テンプレート内の既存の設定が干渉する為に、思った結果が得られなかったとします。
その際、テンプレートの該当部分を削除してしまうと、後程、復旧する事が出来ません。
そこで、該当部分をコメントアウトしておけば、後で元に戻せない等と言ったリスクを回避する事が可能です。

▲もくじへ戻る

内部対策に悪影響を与えないコメントアウト

HTML用のコメントアウトをご紹介しました。

<p>カモノハシ</p>
<!--<p>カブトガニ</p>-->
<p>シーラカンス</p>

これをブラウザ上で確認すると、コメントアウト部分は表示されません。

ブラウザ上の表示

ですが、キーボードの「Ctrl」と「U」を同時に入力してソースコードを確認すると、しっかりと、コメントアウト部分も表示されています。

コメントアウト部分も表示される

コメントアウト部分が少々ある分には大きな影響は無いでしょうが、あまりにも沢山のコメントアウト部分がある場合は考えものです。
ページ内のキーワード比率が下がる為、SEOの内部対策上、得策とは言えません。

一方、PHPのコメントアウトはソースコード上にも表示されません。
ですから、HTMLでコメントアウトする所を、敢えて、PHPでコメントアウトしてしまうと言う手法もあります。

方法は簡単です。
以下のように記述してPHPでコメントアウトすれば、ソースコード上にも表示されないコメントアウトが出来ます。

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

▲もくじへ戻る

まとめ

PHPのコメントアウト機能

今回は、PHPのコメントアウト機能についてご紹介しました。

おさらいをすると、PHPでコメントアウトをする方法を三通りご紹介しました。
また、コメントアウトの失敗例として、入れ子にしてしまう例や、PHP外でコメントアウトしてしまう例をご紹介しました。
活用法としては、目印として使用する方法や、特定部分を停止させる目的で使用する方法HTMLのコメントアウトの代わりに使用する方法についてご紹介しました。

どうでしょう?
少しはお役に立つ情報がありましたでしょうか?
この記事があなたのサイトをより良くする結果に繋がれば、嬉しく思います。

にほんブログ村 イラストブログ Photoshopへコンピュータグラフィックス ブログランキングへFC2ブログランキングブログランキングならblogram i2iブログランキング

タグ :   

ホームページ作成 Webデザイン   コメント:0

この記事に関連する記事一覧

TOPへ戻る