ホームページ作成/HTML・スタイルシート(CSS)の基礎

スタイルシートのコメントを活用しよう!

スタイルシートのソース中でコメントを活用していますか? 長いソースを後日に読むと、どこに何を書いたのか分からなくなることがあります。ソース中のコメントで補足して、後々のメンテナンスを楽にしましょう。

西村 文宏

西村 文宏

ホームページ作成 ガイド

初心者向けの「わかりやすさ」を重視した解説に定評があるウェブ系テクニカルライター。ウェブの黎明期に趣味で始めた個人サイト製作からその「楽しさ」に魅了され、作成方法に関する様々な情報を発信。企業や団体のウェブサイト製作・解説書籍の執筆なども行っている。

...続きを読む

コメントを活用して見やすいソースに

スタイルシートのソース中で、コメントを活用していますか? HTMLと同じように、スタイルシートのソース中にもコメントを書くことができます。

ソースが長くなると、後日読み直したときに、どこに何を記述したのか分からなくなることがよくあります。 また、他人が書いたソースは、どういう意図でそう書いているのか分からない場合があります。 そんなとき、コメントで補足されていれば、ソースだけからは分からない情報を伝えたり思い出したりすることができます。

また、長いソースを目的別や適用場所別に区切って、読みやすくするためにも活用できます。 「ヘッダ部分」・「フッタ部分」など、適用箇所を示したタイトルをコメントとして書いておけば、読みやすいソースになります。

ぜひ、コメントを活用してソースを書いてみて下さい。

コメントを活用したスタイルシートソースの例

次の例では、「右側のサイドバー」用のスタイルにコメントを加えています。最初に、「ここから右側のサイドバーに関するスタイルを記述する」という意味で、 大きく「右側のサイドバー」という見出しを書いています。 非常に長いソースを記述する場合には、このように、目立つコメントを「ソース内の見出し」として活用する方法がよく使われます。 また、内側の記述でも、それぞれのスタイルが何をデザインしているのかを補足しています。

/* ================== */
/*  右側のサイドバー  */
/* ================== */
div.sidebar {
   float: right;
   width: 18%;
   /* バーのデザイン */
   background-color: #ffffcc;
   border-left: dashed green 1px;
   /* 余白 */
   margin-left: 10px; /* 左の段との間隔を少し空ける */
   padding: 0.3em;
}

このようにコメントを記述することで、ソースの量は多くなってしまいますが、後々のメンテナンスは楽になります。

  • 1
  • 2
  • 次のページへ

あわせて読みたい

カテゴリー一覧

All Aboutサービス・メディア

All About公式SNS
日々の生活や仕事を楽しむための情報を毎日お届けします。
公式SNS一覧
© All About, Inc. All rights reserved. 掲載の記事・写真・イラストなど、すべてのコンテンツの無断複写・転載・公衆送信等を禁じます