CSSのコメントについて
- コメントの書き方
-
後で見直しても、わかりやすいようにスタイルシートを記述していくことは大切です。特にコンテンツが増えてくると、それに比例してスタイルシートの量も増えてきます。そのとき、整理するためにもコメントの役割は重要です。コメントは「/*」と「*/」で挟んだ部分になります。これは1行だけでなく、行をまたいでも有効です。
/* この挟まれた部分がコメントになります */また、日本語でコメントを書くときは、CSSの一番最初の行に、@charsetでエンコードの指定を必ずしておきましょう。そうしないと、日本語のコメントを書くときにスタイルシートが意図した通り読み込んでくれないことがあります。
- コメントを目立たせる
-
普通にコメントを記述するのでは、スタイルシートの指定に埋もれてしまい、あまり目立たないです。そこで、ハイフンなどの文字を使って装飾すると、よりわかりやすくなり視認性もアップします。下記に有名サイトのコメント記述例をリストします。
■MAJOR.JP
/*----------------------------------------
ここにコメント
-----------------------------------------*/■The Web KANZAKI
/* =============================================== */
/** コメント
/* ----------------------------------------------- */■もじら組
/* ******************** コメント ******************** */■Six Apart
/* -------------------------------------------------- コメント */ - div要素に対するコメント
-
CSSのレイアウトでは、Webページの骨格に当たる部分をdiv要素を使って入れ子にしていきます。そのとき、どの要素がどれを閉じているのか判別しやすいように、それにもコメントを付けておきましょう。下記が一例です。
<div id="wrapper">
<div id="content">
:
:
</div><!-- /content -->
</div><!-- /wrapper -->