CSS
 Computer >> コンピューター >  >> プログラミング >> CSS

CSSコメントの書き方:基本構文からコメントアウトの実践テクニックまで

CSSスタイルシートにコメントを書くことで、コードの意図や内容を簡潔に記録(説明)できます。これは自分自身のためだけでなく、チームメンバーがコードを理解する際にも大いに役立ちます。

CSSコメントの基本構文

CSSでコメントを書くには、次の構文(フォーマット)を使用します。

/* これはCSSのコメントです */

/* */」という形式は、CSSでコメントを記述できる唯一の方法です。そのため、1行コメントにも複数行コメントにも、この同じ形式が使われます。

/* 
   これは複数行にわたる
   CSSコメントです。
   ブロックコメントとも呼ばれます。
*/

コメントアウトの実例

次に、コメント構文を使ってルールセット内のCSSコードを「コメントアウト」する例をいくつか紹介します。

.box {
  background-color: #000;
  padding: 1.5rem;
  /* border-radius: 4px; */
}
.box {
  background-color: #000;
  padding: 1.5rem; /*
  border-radius: 4px;
  box-shadow: 5px 10px #888888;
  */
}

実際の開発現場では、コメントはコードのドキュメント化だけでなく、テスト中に特定のスタイル宣言を一時的に無効化(コメントアウト)する目的でも頻繁に使われています。

CSSとJavaScriptのコメントの違いに注意

CSSのコメントとJavaScriptのコメントを混同しないようにしましょう。JavaScriptでは、複数行コメントに「/* */」(CSSと同じ形式)を使用し、1行コメントにはスラッシュ2つの「//」を使用します。

  • 1行コメントは「インラインコメント」とも呼ばれます。
  • 複数行コメントは「ブロックコメント」とも呼ばれます。

CSSのコードなのに「//」で1行コメントを書いているプロジェクトを見かけたことがあるかもしれません。よく観察してみると、それらのプロジェクトはSass/SCSSやLessといったCSSプリプロセッサを使用しています。これらの言語はJavaScriptと同様に1行コメントをサポートしています。一方、素のCSS(バニラCSS)では、残念ながら「/* */」しか使用できません。

CSSコードにコメントを書くべきか?

HTMLへのコメントの付け方に関するチュートリアルでも触れたように、このトピックについては開発者の間でも意見が分かれています。「コードは明示的で、それ自体が説明になるべきだ」と考える人もいます。

私にとって、この問題は白黒はっきりつけられるものではありません。すべてのコメントが等しく有用というわけではないからです。CSSスタイルシートを小説の執筆場所にしてはいけませんが、短く簡潔なコメントは、初心者やチームの新メンバーがコードの動きを理解するうえで大きな助けとなります。

私なら、どんな時でも「暗黙的」よりも「明示的」なコードを選びます。

また、コメントがファイル容量を圧迫してページの読み込み速度に悪影響を与えるのではないかと心配する必要もありません。パフォーマンスやページ読み込み速度の改善において、コメントなどのテキストは最優先で対処すべき項目ではありません。さらに、ポストプロセスの段階でコメントを自動的に削除してくれるツールも存在します。

  1. Excelのセルにコメントを追加する方法!バージョン別に徹底解説

    Excelを日常的に使っていると、「この数式は何を計算しているのか」「このセルの値はなぜ必要なのか」といった疑問が生まれることがあります。セルにコメントを追加すれば、数式やデータの説明をスプレッドシート上に直接残せるため、同僚への電話や口頭での説明にかかる時間を大幅に節約できます。 ところが意外にも、Excelでコメント機能を活用している人は多くありません。そこで本記事では、Excel 2013、2010、2007、XP/2003の各バージョンにおけるコメントの追加方法をわかりやすく解説します。さらに、コメントの書式設定や図形の変更、コピー方法といった応用テクニックもご紹介します。 Excel

  2. Wordでコメントを追加・削除する方法|返信や解決の操作もわかりやすく解説

    文書を相手と同じ場所で一緒に確認できないとき、次善の策となるのがコメント機能です。Microsoft Wordでは、テキストを選択してコメントを挿入するだけで簡単にフィードバックを残せますし、既存のコメントに返信して意見を交わすこともできます。 グループプロジェクトでの共同作業、友人の小説のプロットへの感想、あるいは自分自身の原稿の編集など、コメント機能はあらゆる場面で役立つ強力なツールです。この記事では、Wordでコメントを追加・削除する方法を詳しく解説します。 注: 本記事のスクリーンショットはmacOS版のMicrosoft Wordを使用していますが、Windows版でも手順は同じ