HTML・CSS:コメントアウトの仕方

コメントアウトとは

 皆さんは自分の記憶に絶対的な自信を持てますか?いちもんじは持てません。(きっぱり言います)
なので、あとから自分のスクリプトを見返したときに「あれ~?この命令文っていったいどんな意図を持って書いたんだっけ?」となりかねないので、事前に対策を打っておきます。

それがこのコメントアウトです。

なぜコメントアウトが大事なの?

 もしもあなたがHPを制作する会社に就職するとして、社員みんなで各ページを分担してページ制作をすることになりました。あなたももちろん命令文を書きます。もりもり書きます。
さて、ひょんなある日。あなたは今日有給を取り、推しのライブを見に行きます。仲間があなたの作っていたページを編集しなければならなくなりました。その仲間は当然ながらあなたの書いたHTMLを見ますね。そして言います。「なんじゃこりゃ~!」と。

その仲間は、あなたがつらつらもりもりと書いたHTMLを上から下まで読み直して分析し、そして解釈する手間がかかります。なんて効率が悪いんだ!?
それを避けるためにも、どのプログラミング界(?)においてもコメントアウトって大事って話です。

HTMLのコメントアウトの方法

HTMLのコメントアウトはこんな感じです。

<!-- ここに伝えたいことを書きます -->

エディタを使用する場合は機能をあらかじめ登録しておくと便利です。VisualStudioCodeの場合、もともとショートカットキーが用意されていて「ctrl」キーと「?」キーを同時に押すことによって自動的に挿入することが可能です。(10/10追記 –!>としていましたが、最後に!は必要ありませんでした…。修正済みです。)

あなたが使用しているエディタにもこのような便利な機能があるならば登録しておくといいかもしれません。

CSSのコメントアウトの方法

CSSのコメントアウトはこんな感じです。

/* ここにコメントを書きます */
/*
複数にまたがるときは
こんな感じで。
コメントの中に「/*」を書くのは
アウトです。
*/

HTMLとCSSのコメントアウトの書式は異なるんですね~。気を付けましょう。

タイトルとURLをコピーしました