HTMLのコメントアウトとは
コメントアウトは、プログラムに影響がない形で、ソースコードに文字を書きこめるものです。
例えば、更新日付や更新者などをコメントアウトで記載し、バージョンを管理するときや、ページの大まかな概要をメモとして残す時に使います。
コメントアウトの書き方
<!--メモ-->
HTMLのコメントの書き方は1種類です。上記のように記載します。
<!--
メモ
メモ
-->
複数行コメントアウトしたい際には、上記のように記載します。いくら改行しても<!– –>の間に記載していれば、全てコメントになります。改行するかしないかは、プロジェクトのコーディング規約や読みやすさで決まります。プロジェクトの中でコメントの書き方が明確に決まっている場合にはそれに従うのが良いです。
また、複数行コメントアウトする際は、見やすいようにコメント本文は全て字下げておくと、他の人が見た際にも分かりやすく、親切なソースコードになります。
コメントアウトのショートカットキー
コメントアウトにはショートカットキーがあります。
覚えると簡単に時短できるので、ぜひ使いましょう!
Macの場合:command + /
Windowsの場合:Ctrl + /
コメントアウトの注意点
<!--<!--メモ-->メモ-->
コメントの中にコメントを入れることはできないので注意が必要です。
ブラウザで確認すると、上記のように中に入れたコメントの–>がコメントの終了宣言とみなされ、そこでコメントが終わってしまうことがあります。
まとめ
いかがでしたでしょうか?
今回の記事では、HTMLでのコメントアウトの使い方を解説しました。
こちらの記事を参考に、見やすいソースコードづくりを目指していきましょう!