インデントとコメント
インデントで入れ子の関係を示し、コメントで意図を残すと、自分にも他人にも読みやすいコードになります。
インデントは要素の親子関係を字下げで表します。コメントは表示されないメモで、書き方は言語ごとに異なります。
読みやすいコードは直しやすい
コードは一度書いて終わりではなく、後から何度も読み返して修正します。読みにくいコードは、どこを直せばよいかを探すだけで時間がかかります。
読みやすさを大きく左右するのが、インデントとコメントです。どちらもブラウザの表示には影響しませんが、コードを読む人にとっては重要な手がかりになります。
インデントで構造を見せ、コメントで意図を残すと、コードは読みやすくなります。
インデントで入れ子の関係を示す
インデントとは、行の先頭に空白を入れて字下げすることです。HTMLでは、ある要素の中に入る子要素を、親要素より一段下げて書きます。
たとえば <ul> の中の <li> を一段下げておくと、どの項目がどのリストに属しているかが一目で分かります。字下げがないと、閉じタグの対応を目で追うのが難しくなります。
ブラウザはインデントの空白を無視して表示します。字下げを入れても、見た目が変わる心配はありません。
インデントの幅はファイル内でそろえる
一段の幅は、半角スペース2つか4つ、またはタブ1つが一般的です。どれを使うかより、同じファイルの中でそろえることが大切です。
スペースとタブが混ざると、エディタによって字下げの見え方がずれます。コードエディタの設定で幅を決めておき、自動整形の機能を使うと、手作業でそろえる手間が減ります。
既存のファイルを編集するときは、そのファイルで使われている幅に合わせます。自分の好みで書き方を変えると、同じファイルの中で書き方が混ざり、かえって読みにくくなります。
CSSは1行に1つの指定を書く
CSSでは、セレクタの後の波かっこの中を一段下げ、プロパティを1行に1つずつ書くのが一般的です。指定が横に長く並ぶより、どのプロパティがあるかを見つけやすくなります。
ルールとルールの間には空行を1行入れます。関係の深いルールを近くにまとめておくと、後から探すときにも迷いません。JavaScriptでも、波かっこの中を一段下げる考え方は同じです。
コメントの書き方は言語ごとに違う
コメントは、コードの中に書いておくメモです。ブラウザはコメントを処理しないため、画面には表示されません。書き方は言語ごとに決まっています。
<!-- コメント --> の形で囲む/* コメント */ の形で囲む//、複数行なら /* */ で囲む言語に合わない書き方をすると、コメントとして扱われず、表示や動作がおかしくなります。たとえばCSSの中で // を使っても、コメントにはなりません。
WordPressのカスタムHTMLブロックや追加CSSの欄に書く場合も、同じ書き方が使えます。
コメントには目的や理由を書く
コードを読めば分かることを、そのままコメントにする必要はありません。書いておくと役立つのは、なぜその書き方をしたのか、という理由です。
たとえば、特定の画面幅で崩れを防ぐための指定や、外部サービスの指示に合わせた記述などは、理由を残しておくと後で誤って消されにくくなります。長いファイルでは、ヘッダー用、フッター用のように区切りのコメントを入れると、目的の場所を探しやすくなります。
コメントを使うときの注意点
HTMLのコメントは画面には出ませんが、ページのソースを表示すれば誰でも読めます。パスワードや社内の情報など、公開したくない内容は書きません。
コードを変更したのに、古いコメントが残っていると誤解のもとになります。コードを直したら、関係するコメントも見直します。
一時的に一部の記述を無効にしたいときは、その部分をコメントで囲む方法が使えます。不要になったら、コメントのまま残さず削除します。
まとめ
インデントは要素の入れ子を字下げで示し、幅はファイル内でそろえます。コメントは言語ごとの書き方で、目的や理由を残すために使います。どちらも表示には影響しませんが、後から直すときの手間を大きく減らします。