HTML・文章にひと工夫

コメントでメモを残そう

画面には表示されないけれど、コードの中に自分や仲間へのメモを残せる。それがコメント。書き方はとってもかんたん。

コードを書いていると、「ここ何のためだっけ?」と後で自分でも忘れてしまうことがあります。そんなときのために、HTMLには画面に出ないメモを書く仕組みがあります。それがコメントです。

書いてみよう

<!-- ここからじこしょうかいエリア -->
<p>おえかきがすきな、しまちゃんです。</p>
<!-- ここまで -->

このページをブラウザで開いても、見えるのは「おえかきがすきな、しまちゃんです。」だけ。<!-- --> で囲んだ部分は画面に出ません。でもコードを開けばちゃんと残っている——これがコメントです。

どんなときに使う?

コメントの出番は、たとえばこんなとき。

使いみちどんなとき
メモを残す「ここは後で画像に差し替える」など、未来の自分へのひとこと
区切りをつける「ここからヘッダー」のように、長いコードの目印にする
一時的に消す消したくないけど今は表示したくないタグを、囲って“お休み”させる

3つめの「お休みさせる」は便利です。

<!-- <p>じゅんびちゅうのメッセージ</p> -->

タグごと <!-- --> で囲むと、消さずに非表示にできます。あとで囲みを外せば、また表示されます。このように「コメントで囲んで無効にする」ことを、プログラミングの世界ではコメントアウトと呼びます。「一回消してみたいけど、戻せなくなったらこわい」——そんなとき、削除のかわりにコメントアウトしておけば、いつでも元にもどせて安心です。

ショートカットで一発

コメントは、毎回 <!----> を手で打たなくても大丈夫。VSCodeなら、コメントにしたい行を選んで Ctrl + /(Macは command + /)を押すだけで、行がまるごと <!-- --> で囲まれます。もう一度押せば、囲みが外れて元どおり。「お休みさせる↔もどす」の切り替えが一瞬でできるので、ぜひ覚えておきましょう。

べんりワザ覚えて得するVSCodeショートカットコメントの切り替えのほかにも、覚えて得するVSCodeのショートカットをまとめています1

このレッスンのまとめ

  1. コメントは <!----> ではさむ
  2. ブラウザには表示されない、コードの中のメモ
  3. 目印にしたり、タグを一時的にお休みさせたりできる

コメントは、未来の自分への手紙。ていねいに残しておくと、あとで自分がいちばん助かります。

やってみよう

しまちゃんのページには使いません(コメントはコードの中だけのメモで、画面には出ないので)。練習用のファイルに段落を2つ書いて、片方だけを <!----> で囲って“お休み”させてみましょう。ブラウザに出るのは、囲まなかった方だけ。囲みを外すと、また出てくる——この切り替えを試しておけば、必要になったときにすぐ使えます。

よくある質問

コメントアウトとはどういう意味ですか?
コードをコメントの記号で囲んで、消さずに一時的に無効にすることです。HTMLでは<!--と-->で囲んだ部分が画面に表示されなくなります。
コメントを書きすぎるとページが重くなりますか?
表示への影響はほとんどありませんが、コメントもファイルの一部なので、書いたぶんだけファイルは大きくなります。ふつうにメモを残す量なら気にしなくて大丈夫です。
コメントをすばやく書くショートカットはありますか?
あります。VSCodeなら行を選んでCtrl+/(Macはcommand+/)を押すと、コメントで囲む・外すを一発で切り替えられます。