HTMLやPHPファイル内にメモ書きを残したり、プログラムの一部を無効化したいけどコードは残しておきたい場合などに便利な「コメントアウト」。この記事ではWordPressのテーマファイルを編集したり自作したりする場合には必須ともいえるコメントアウトの方法をご紹介します。
目次
コメントアウトとは
コメントアウトとはプログラムのソースコードなどの一部を指定して、その部分のソースコードは残したまま無効化する手法です。
指定された部分はプログラムに解釈されない（無効化される）ようになっているため、作成中のサイトの挙動がおかしい時にプログラムのどの部分に問題があるのか特定するために使用したり、ファイル内にメモ書きを残したい場合にも有効です。
HTMLのコメントアウト
<!DOCTYPE html> <html lang="ja"> <body> あいうえお <!--かきくけこ--> さしすせそ </body> </html>
HTMLで記述されたコードをコメントアウトするには、コメントアウトしたい部分を「<!--」と「-->」で囲みます。コメントアウトする部分は1行でも複数行にわたってもかまいません。
上記のコードだと「かきくけこ」がコメントアウトされ、ブラウザには あいうえおさしすせそ と表示されます。
CSSのコメントアウト
ul {
list-style: disc;
}
/*メモ書き*/
/*
body {
background-color: #fff;
}
*/
CSSで記述されたコードをコメントアウトするには、コメントアウトしたい部分を「/*」と「*/」で囲みます。コメントアウトする部分は1行でも複数行にわたってもかまいません。
上記のコードだと「メモ書き」と書かれた部分はコメントアウトされ、body要素への「background-color: #fff;」という指定もコメントアウトされてCSSが適用されません。
CSSではメモ書きのために使うことが多いかと思います。
ちなみに「/*」と「*/」で囲んだコメントをさらに「/*」と「*/」で囲んでコメントを入れ子にすることはできません。
PHPのコメントアウト
<?php echo 'あいうえお'; // 1行コメントアウト /* 複数行用のコメントアウト echo 'かきくけこ'; この行もコメントアウトされます */ echo 'さしすせそ'; ?>
PHPで記述されたコード（「<?php」から「?>」で囲まれた部分）をコメントアウトするには2通りの方法があります。
コメントアウトしたい部分が1行の場合は「//」と記述することでその行のそれ以降の部分をコメントアウトすることができます。複数行をコメントアウトする場合は「/*」と「*/」で囲むことでそれらに囲まれた部分をコメントアウトすることができます。
JavaScriptのコメントアウト
<script type="text/JavaScript"> // 1行コメントアウト /* 複数行のコメントアウト この行もコメントアウト */ </script>
JavaScriptで記述されたコードをコメントアウトする場合はPHPと同様、1行の場合は「//」、複数行の場合は「/*」と「*/」で囲みます。
何を使えばいいかよくわからない場合
WordPressのテーマファイルは多くがPHPファイルのためHTMLコードの中でところどころPHPコードが記述されており、不慣れな方はHTMLとPHPどちらのコメントアウトを使えばいいか迷ってしまう場合があります。
そういった場合は下記のコードを使いましょう。
<?php /* コメントアウトする部分 */ ?>
「<?php /*」と「*/ ?>」で囲うことで自らPHPの開始宣言をしてからコメントアウトをして、その後PHPの終了宣言をしています。
ただし該当箇所がHTMLなのかPHPなのかすらわからない状態でテーマをいじるのはいささか危険です。テーマをいじっていて混乱してしまった時の応急措置くらいに考えておきましょう。
