この記事を読めば…
WordPressで必要なHTML、CSS、PHP、JavaScriptのコメントアウトの書き方がわかります。
(編集前にファイルのバックアップとるのってめんどうやな…)
ファイルを編集するたびにバックアップを取るのも手間がかかりますよね。そういう時は、手軽に行えるコメントアウトを利用しましょう。
処理の無効化・変更前の内容に戻すことが簡単に行えます。
コメントアウトとは?
プログラミング言語では、プログラム中にコメントを挿入することができます。コメントは、コンピュータが処理を行うときは無視されるので、プログラムをする人のためのメモとして使用されるものです。
1 2 | <!-- この部分がコメントです。コメントは表示されません。 --> < p >コメントは、プログラムをする人のためのメモ書きです。</ p > |
このコメントが処理をされないというのを利用して、一部の処理をコメント化することをコメントアウトと呼びます。
1 2 | <!-- p>コメントは、プログラムをする人のためのメモ書きです。</p --> < p >コメントアウトは、該当部分の処理をコンピュータに無視させます。</ p > |
コメントアウトのメリットとデメリット
削除するのではなく、コメントアウトを行うことには大きなメリットがあります。
- 以前の変更内容をファイル上に残したままにできる
- 変更内容を以前のものに戻すのが容易である
しかし、次のようなデメリットもあります。
- コメントアウトが多くなりすぎると、コードが読みづらくなってしまう
コメントアウトの使いすぎには注意しましょう。
コメントアウトが多くなりすぎたら、ファイルのバックアップをとってコメントアウトの部分を整理しよう
コメントアウトの書き方
WordPressで必要な各言語のコメントアウトの書き方を紹介します。
PHPとJavaScriptでは、1行のみコメント化する方法が別にあります。状況に合わせて使い分けを行ってください。
1 2 3 4 | <!-- HTMLのコメントアウト --> <!-- HTMLは1行でも複数行でも コメントアウトの書き方は同じです。 --> |
1 2 3 4 | /* CSSのコメントアウト */ /* CSSは1行でも複数行でも コメントアウトの書き方は同じです。 */ |
1 2 3 4 | // PHPのコメントアウト /* PHPは1行と複数行の コメントアウトが異なります。 */ |
1 2 3 4 | // JavaScriptのコメントアウト /* JavaScriptは1行と複数行の コメントアウトが異なります。 */ |
コメントの中にコメントを入れると、うまくコメントアウトできない時があるから気をつけてね