CSS ファイルにコメントを追加すると、正しく使用できれば、開発プロセス中に自分や他の人にとって非常に役立ちます。最も一般的なのは、CSS スタイル ルールにヒント情報を追加することですが、コメントを使用することも、組織構造を最適化し、実用性を向上させるのに役立ちます。
ヒントとタグ
これは、注釈を付ける最も一般的な方法です。後で不要な混乱やトラブルを避けるために、自分自身または他の開発者向けにヒントを残すことができます。このアプリケーションのシンプルさが最も重要です。例:
/* リンクされた画像の境界線をオフにする */
img { border: 0 }
タイムスタンプと署名
多くのデザイナーや開発者は、最新に更新された CSS ファイルに日付と時刻、およびファイル名をマークします。これらにより、連絡先情報とドキュメントの更新情報が提供されます。
/* スタイル更新日: 2008 年 4 月 8 日木曜日、午後 5 時 15 分 著者: 52CSS.com ——-*/
この方法は、プロジェクト、特にチームの一員である場合に非常に役立ちます。組織によっては、この情報を文書に残すことを要求していることや、名前や日付を文書の外に残すことを好む企業もあるので、始める前にこれらのことを明確にしておくのが最善です。
コメントを使用して CSS ドキュメントのさまざまなセクションを示すことをお勧めします
。
たとえば、すべてのヘッダー情報がグループ化されている場合、コメントを使用して以下のブロック スタイルと区別できます。
/* HEADER ———————————————-*/
これについては次に詳しく説明しますが、まず
CSS ファイルの場合に
注釈タグを
「スタイル タイプを分離する」方法について説明します。上で述べたように、文書はブロックに分割されていますが、コメント マーカーを使用すると「検索」機能と連携して、文書のさまざまな部分を簡単に切り替えることができます。等号「=」を使用するなどして章 (Chapter) をマークし、その後に「HEADER」などのブロック名を追加して、CSS ドキュメントの「アンカー」を作成します。
/* =HEADER —————————————————-*/
このメソッドは、複雑なコンテンツを含むスタイル シートで特に便利です。