コメントの書き方

画面に出ないメモ

HTML には、ブラウザが無視してくれるメモを書けます。これがコメントです。

コメントは画面には表示されませんが、ページのソースを見れば誰でも読めます。パスワードのような他人に見せたくない情報は書かない、と覚えておいてください。

何のために使うのか

いちばん多い使い道は、どこからどこまでが何の部分なのかという目印です。コードは書いた直後は覚えていても、1 週間後の自分はきれいに忘れています。区切りにコメントがあるだけで、直したい場所をすぐ見つけられます。

もう 1 つの使い道が、一時的に消す使い方です。タグをコメントではさむと、消さずに表示だけを止められます。うまく動かないときに、どこが原因かを探すのに便利です。

目印を付けながら読み返そう

名前、自己紹介、趣味、経歴、リンクの 5 か所の手前にコメントを入れます。上から順にコメントを付けていくと、自分の書いたコードを自然に読み返すことになります。

実はいまの趣味のリストは 3 つしかありません。読み返して気づいたところは、そのついでに直しておきましょう。ここでは li を 1 つ足して 4 つにします。

1. 名前、自己紹介、趣味、経歴、リンクの 5 か所の手前にコメントを入れる
2. コメントには何の部分かが分かる言葉を書く
3. 趣味の ul に li を 1 つ足して 4 つにする