Bootstrap CSSコーディング規約

语法

  • タブの代わりにスペース2つを使用します。これは、すべての環境で一貫した表示を保証する唯一の方法です。
  • セレクタをグループ化するときは、個々のセレクタをそれぞれ1行に配置します。
  • コードの可読性のため、各宣言ブロックの左中括弧の前にスペースを1つ追加します。
  • 宣言ブロックの右中括弧は単独で1行にすべきです。
  • 各宣言文の:後にはスペースを挿入すること。
  • より正確なエラー報告を得るために、各宣言はそれぞれ1行にすべきです。
  • すべての宣言文はセミコロンで終わるべきです。最後の宣言文の後のセミコロンは省略可能ですが、省略するとコードがエラーを起こしやすくなる可能性があります。
  • カンマで区切られたプロパティ値では、各カンマの後にスペースを1つ挿入します(例、box-shadow)。
  • しないでくださいrgb()、rgba()、hsl()、hsla() 或 rect()値の内部カンマの後にスペースを挿入します。これにより、複数のプロパティ値(カンマとスペースの両方)と複数の色値(カンマのみ、スペースなし)を区別しやすくなります。
  • プロパティ値または色の引数では、1未満の小数の前の0を省略します(例、.5代替0.5;-.5px代替-0.5px)。
  • 16進数の値はすべて小文字にすべきです。例、#fffドキュメントをスキャンするとき、小文字の文字は、その形式が区別しやすいため、認識しやすくなります。
  • 可能な限り短縮形の16進数値を使用します。例えば、次のようにします。#fff代替#ffffff。
  • セレクタ内の属性には二重引用符を追加します。例、input[type="text"]。特定の場合にのみオプションですただし、コードの一貫性のために、すべてに二重引用符を付けることを推奨します。
  • 0の値に単位を指定しないでください。例、次のようにします。margin: 0;代替margin: 0px;。

ここで使用されている用語について疑問がありますか? Wikipedia の层叠样式表 - 语法。

/* Bad CSS */
.selector, .selector-secondary, .selector[type=text] {
  padding:15px;
  margin:0px 0px 15px;
  background-color:rgba(0, 0, 0, 0.5);
  box-shadow:0px 1px 2px #CCC,inset 0 1px 0 #FFFFFF
}

/* Good CSS */
.selector,
.selector-secondary,
.selector[type="text"] {
  padding: 15px;
  margin-bottom: 15px;
  background-color: rgba(0,0,0,.5);
  box-shadow: 0 1px 2px #ccc, inset 0 1px 0 #fff;
}

声明顺序

関連するプロパティ宣言はグループにまとめ、以下の順序で並べること:

  1. Positioning
  2. Box model
  3. Typographic
  4. Visual

位置指定(positioning)は通常のドキュメントフローから要素を取り除き、ボックスモデル(box model)関連のスタイルも上書きできるため、最初に置く。ボックスモデルはコンポーネントのサイズと位置を決定するため、2番目に置く。

その他のプロパティは、コンポーネントの...にのみ影響します。内部(inside)あるいは、最初の2つのグループには影響しないため、後ろに配置されます。

完全なプロパティのリストとその並び順については、次を参照してください。Recess。

.declaration-order {
  /* Positioning */
  position: absolute;
  top: 0;
  right: 0;
  bottom: 0;
  left: 0;
  z-index: 100;

  /* Box-model */
  display: block;
  float: right;
  width: 100px;
  height: 100px;

  /* Typography */
  font: normal 13px "Helvetica Neue", sans-serif;
  line-height: 1.5;
  color: #333;
  text-align: center;

  /* Visual */
  background-color: #F5F5F5;
  border: 1px solid #E5E5E5;
  border-radius: 3px;

  /* Misc */
  opacity: 1;
}

不要使用@import

と<link>标签相比,@import@import ディレクティブははるかに遅く、余分なリクエスト回数が増えるだけでなく、予期しない問題を引き起こす可能性があります。代替方法は次のとおりです。

  • 使用多个<link>元素
  • Sass や Less などの CSS プリプロセッサを使用して、複数の CSS ファイルを1つのファイルにコンパイルします。
  • Rails、Jekyll、または他のシステムで提供されている CSS ファイル結合機能を使用します。

请参考Steve Souders の記事さらに詳しい知識を得る。

<!-- Use link elements -->
<link rel="stylesheet" href="core.css.html">

<!-- Avoid @imports -->
<style>
  @import url("more.css");
</style>

メディアクエリの位置

メディアクエリは、関連するルールのできるだけ近くに置くこと。それらを1つのスタイルシートファイルにまとめて置いたり、ドキュメントの最後に置いたりしないこと。それらを分けてしまうと、将来みんなに忘れられてしまうだけだ。以下に典型的な例を示す。

.element { ... }
.element-avatar { ... }
.element-selected { ... }

@media (min-width: 480px) {
  .element { ...}
  .element-avatar { ... }
  .element-selected { ... }
}

接頭辞付きプロパティ

特定ベンダーの接頭辞付きプロパティを使用する場合、インデントによって各プロパティの値を垂直方向に揃えてください。これにより複数行編集が容易になります。

Textmate では、使用します。Text → Edit Each Line in Selection(⌃⌘A)。Sublime Text 2 では、Selection → Add Previous Line(⌃⇧↑) とSelection → Add Next Line (⌃⇧↓)。

/* Prefixed properties */
.selector {
  -webkit-box-shadow: 0 1px 2px rgba(0,0,0,.15);
          box-shadow: 0 1px 2px rgba(0,0,0,.15);
}

単一行のルール宣言

に対して1つの宣言のみを含むのスタイルでは、可読性と迅速な編集の容易さのため、ステートメントを同じ行に配置することをお勧めします。複数の宣言を持つスタイルでは、宣言を複数行に分けるべきです。

これを行う主な理由はエラー検出です -- 例えば、CSS バリデータが183行目に構文エラーを指摘した場合。1行に1つの宣言であれば、このエラーを見逃すことはありません。1行に複数の宣言がある場合は、エラーを見逃さないように注意深く分析する必要があります。

/* Single declarations on one line */
.span1 { width: 60px; }
.span2 { width: 140px; }
.span3 { width: 220px; }

/* Multiple declarations, one per line */
.sprite {
  display: inline-block;
  width: 16px;
  height: 15px;
  background-image: url(../img/sprite.png);
}
.icon           { background-position: 0 0; }
.icon-home      { background-position: 0 -20px; }
.icon-account   { background-position: 0 -40px; }

ショートハンド形式のプロパティ宣言

すべての値を明示的に設定する必要がある場合、短縮形のプロパティ宣言の使用はできるだけ制限すべきです。短縮形のプロパティ宣言のよくある誤用は次のとおりです。

  • padding
  • margin
  • font
  • background
  • border
  • border-radius

ほとんどの場合、短縮形のプロパティ宣言にすべての値を指定する必要はありません。例えば、HTML の見出し要素は上下のマージン(margin)の値のみを設定する必要があるため、必要な場合はその2つの値だけを上書きすれば十分です。短縮形のプロパティ宣言を過度に使用すると、コードが混乱し、プロパティ値に不要な上書きが生じて、予期しない副作用を引き起こす可能性があります。

MDN(Mozilla Developer Network)にある非常に優れた〜に関するshorthand propertiesの記事は、短縮形のプロパティ宣言とその動作にあまり詳しくないユーザーに役立ちます。

/* Bad example */
.element {
  margin: 0 0 10px;
  background: red;
  background: url("image.jpg");
  border-radius: 3px 3px 0 0;
}

/* Good example */
.element {
  margin-bottom: 10px;
  background-color: red;
  background-image: url("image.jpg");
  border-top-left-radius: 3px;
  border-top-right-radius: 3px;
}

Less と Sass におけるネスト

不必要なネストは避けてください。ネストを使用できるからといって、ネストを使用すべきというわけではありません。スタイルを親要素内に制限する必要がある場合(つまり子孫セレクタ)、かつネストが必要な要素が複数存在する場合にのみネストを使用します。

// Without nesting
.table > thead > tr > th { … }
.table > thead > tr > td { … }

// With nesting
.table > thead > tr {
  > th { … }
  > td { … }
}

注释

コードは人によって書かれ、保守されます。コードが自己説明的で、適切にコメントされ、他の人が理解しやすいものであることを確認してください。優れたコードコメントは、コンテキストとコードの目的を伝えます。コンポーネント名や class 名を単に繰り返してはいけません。

長いコメントでは必ず完全な文章を書きましょう。一般的な注釈では簡潔なフレーズで構いません。

/* Bad example */
/* Modal header */
.modal-header {
  ...
}

/* Good example */
/* Wrapping element for .modal-title and .modal-close */
.modal-header {
  ...
}

class 命名

  • class 名には、小文字とダッシュ(dashe)のみ使用できます(アンダースコアやキャメルケースは不可)。ダッシュは、関連するクラスの命名(名前空間のようなもの)に使用すること(例:.btnと.btn-danger)。
  • 過度に恣意的なショートハンドは避けること。.btn代表button、しかし.s何の意味も表現できない。
  • class 名はできるだけ短く、かつ意味が明確であるべきです。
  • 意味のある名前を使用します。構造的または目的を明確にした名前を使用し、表現(presentational)に基づく名前は使用しないでください。
  • 直近の親クラスまたは基本(base)クラスに基づいて、新しいクラスの接頭辞とする。
  • 使用.js-*動作(スタイルではなく)を識別するために class を使用し、これらの class を CSS ファイルに含めないでください。

Sass や Less の変数に名前を付ける際も、上記の各規約を参照できます。

/* Bad example */
.t { ... }
.red { ... }
.header { ... }

/* Good example */
.tweet { ... }
.important { ... }
.tweet-header { ... }

选择器

  • 汎用要素には class を使用します。これによりレンダリングパフォーマンスの最適化に役立ちます。
  • 頻繁に使用されるコンポーネントでは、属性セレクタの使用を避けます(例、[class^="..."])。ブラウザのパフォーマンスはこれらの要因によって影響を受ける可能性があります。
  • セレクタはできるだけ短くし、セレクタを構成する要素の数はできるだけ制限してください。3つ以内を推奨します。
  • 只有必要な場合にのみ、class を最も近い親要素内に制限します(つまり子孫セレクタ)(例:接頭辞付き class を使用しない場合 -- 接頭辞は名前空間のようなものです)。

扩展阅读:

/* Bad example */
span { ... }
.page-container #stream .stream-item .tweet .tweet-header .username { ... }
.avatar { ... }

/* Good example */
.avatar { ... }
.tweet-header .username { ... }
.tweet .avatar { ... }

代码组织

  • コンポーネント単位でコードセクションを整理すること。
  • 一貫性のあるコメント規約を策定すること。
  • 一貫した空白を使用してコードをブロックに分割します。これにより、大きなドキュメントをスキャンしやすくなります。
  • 複数の CSS ファイルを使用する場合は、ページ単位ではなくコンポーネント単位で分割します。ページは再構成されることがありますが、コンポーネントは移動されるだけだからです。
/*
 * Component section heading
 */

.element { ... }


/*
 * Component section heading
 *
 * Sometimes you need to include optional context for the entire component. Do that up here if it's important enough.
 */

.element { ... }

/* Contextual sub-component or modifer */
.element-heading { ... }

编辑器配置

一般的なコードの不整合や差分を避けるために、エディタを次の設定に構成します:

  • タブの代わりにスペース2つを使用します(ソフトタブ、つまりスペースでタブを表します)。
  • ファイルを保存するときは、末尾の空白を削除します。
  • ファイルのエンコーディングを UTF-8 に設定する。
  • ファイルの末尾に空白行を追加すること。

ドキュメントを参照し、これらの設定情報をプロジェクトの設定に追加します。.editorconfigファイル内。例:Bootstrap の .editorconfig の例。詳細情報は〜を参照about EditorConfig。

其他扩展