柔軟で安定した高品質の HTML および CSS を記述するためのコーディング標準 code_html/css

何人で同じプロジェクトに取り組んでも、コードの各行が同じ人によって書かれたように見えるようにしてください。

したがって、柔軟で安定した高品質の HTML および CSS コードを書くことは、すべての技術スタッフの基本的な倫理です。

HTML

********** ************************************************* * ************

構文

タブ文字を 2 つのスペース ( tab) に置き換えます-- これが、すべての環境で一貫したプレゼンテーションを保証する唯一の方法です。
ネストされた要素は 1 回インデントする必要があります (スペース 2 つ)。
属性の定義には、必ず二重引用符を使用し、一重引用符は使用しないでください。
自己終了要素に末尾のスラッシュを追加しないでください。HTML5 仕様では、これがオプションであると明示的に規定されています。
オプションの終了タグ (

<!DOCTYPE html><html>  <head>    <title>Page title</title>  </head>  <body>    <img src="images/company-logo.png" alt="Company">    <h1 class="hello-world">Hello, world!</h1>  </body></html>

ログイン後にコピー

************

HTML5 doctype

各ブラウザで一貫した表示を保証するために、各 HTML ページの最初の行に標準モード宣言を追加します。

<!DOCTYPE html><html>  <head>  </head></html>

ログイン後にコピー

************

言語属性

HTML5 仕様によると:

ドキュメントに正しい言語を設定するには、HTML ルート要素に lang 属性を指定することを強くお勧めします。これは、音声合成ツールが使用すべき発音を決定したり、翻訳ツールが翻訳時に従うべきルールを決定したりするのに役立ちます。

<html lang="zh-CN">  <!-- ... --></html>

ログイン後にコピー

*********

IE 互換モード

IE サポート特定のタグを使用して、現在のページを描画するために使用する IE のバージョンを決定します。強い特別なニーズがない限り、エッジモード に設定して、IE がサポートする最新のモードを採用するように通知するのが最善です。

<meta http-equiv="X-UA-Compatible" content="IE=Edge">

ログイン後にコピー

************

文字エンコード

文字エンコーディングを明示的に宣言することで、ブラウザーがページコンテンツをどのようにレンダリングするかを迅速かつ簡単に決定できるようになります。この利点は、HTML で文字エンティティの使用を回避できるため、すべてがドキュメントエンコーディング (通常は UTF-8 エンコーディング) と一致することです。

<head>  <meta charset="UTF-8"></head>

ログイン後にコピー

*********

CSS および JavaScript ファイルの紹介

HTML5 仕様によれば、導入後 CSS ファイルと JavaScript ファイルの type 属性は、それぞれ text/css と text/javascript がデフォルト値であるため、通常は指定する必要はありません。

<!-- External CSS --><link rel="stylesheet" href="code-guide.css"><!-- In-document CSS --><style>  /* ... */</style><!-- JavaScript --><script src="code-guide.js"></script>

ログイン後にコピー

*********

実用性が重要です

HTML 標準とセマンティクスに従うようにしてください。ただし、実用性を犠牲にしないでください。使用するタグを最小限にし、複雑さを常に最小限に抑えるようにしてください。

************

属性の順序

コードを読みやすくするために、HTML 属性は以下の順序で配置する必要があります。

クラス
id、名前
data-*
src、for、type、href
title、alt
aria-*、role

クラスは再利用性の高いコンポーネントを識別するために使用されるため、最初にリストする必要があります。 ID は特定のコンポーネントを識別するために使用され、注意して使用する必要があるため (ページ内のブックマークなど)、2 番目になります。

<a class="..." id="..." data-modal="toggle" href="#">  Example link</a><input class="form-control" type="text"><img src="..." alt="...">

ログイン後にコピー

************

ブール属性

ブール属性は、値を割り当てずに宣言できます。 XHTML 仕様では値を割り当てる必要がありますが、HTML5 仕様では必要ありません。

要素の Boolean 属性に値がある場合は true、値がない場合は false です。

値を割り当てる必要がある場合は、WhatWG 仕様を参照してください:

属性が存在する場合、その値は空の文字列または [.. .] 属性名前を標準化し、末尾の空白を追加しません。

簡単に言えば、値を割り当てる必要はありません。

<input type="text" disabled><input type="checkbox" value="1" checked><select>  <option value="1" selected>1</option></select>

ログイン後にコピー

*********

タグの数を減らす

HTMLを書くときコードでは、冗長な親要素を避けるようにしてください。多くの場合、これを実現するには反復とリファクタリングが必要になります。

<!-- 糟糕案例 --><span class="avatar">  <img src="..."></span><!-- 最佳方案 --><img class="avatar" src="...">

ログイン後にコピー

*********

JavaScript で生成されたタグ

JavaScript で生成されたタグを通じてコンテンツを有効にする検索や編集が難しくなり、パフォーマンスが低下します。できる限り避けてください。

************************* **** *************************************

CSS

*************************** ******** ********************************

文法

タブの代わりに 2 つのスペースを使用します。これが、すべての環境で一貫したプレゼンテーションを保証する唯一の方法です。
为选择器分组时，将单独的选择器单独放在一行。
为了代码的易读性，在每个声明块的左花括号前添加一个空格。
声明块的右花括号应当单独成行。
每条声明语句的 : 后应该插入一个空格。
为了获得更准确的错误报告，每条声明都应该独占一行。
所有声明语句都应当以分号结尾。最后一条声明语句后面的分号是可选的，但是，如果省略这个分号，你的代码可能更易出错。
对于以逗号分隔的属性值，每个逗号后面都应该插入一个空格（例如，box-shadow）。
不要在 rgb()、rgba()、hsl()、hsla() 或 rect() 值的内部的逗号后面插入空格。这样利于从多个属性值（既加逗号也加空格）中区分多个颜色值（只加逗号，不加空格）。
对于属性值或颜色参数，省略小于 1 的小数前面的 0 （例如，.5 代替 0.5；-.5px 代替 -0.5px）。
十六进制值应该全部小写，例如，#fff。在扫描文档时，小写字符易于分辨，因为他们的形式更易于区分。
尽量使用简写形式的十六进制值，例如，用 #fff 代替 #ffffff。
为选择器中的属性添加双引号，例如，input[type="text"]。只有在某些情况下是可选的，但是，为了代码的一致性，建议都加上双引号。
避免为 0 值指定单位，例如，用 margin: 0; 代替 margin: 0px;。

/* 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;}

ログイン後にコピー

*********

声明顺序

相关的属性声明应当归为一组，并按照下面的顺序排列：

Positioning

Box model

Typographic

Visual

由于定位（positioning）可以从正常的文档流中移除元素，并且还能覆盖盒模型（box model）相关的样式，因此排在首位。盒模型排在第二位，因为它决定了组件的尺寸和位置。

其他属性只是影响组件的内部（inside）或者是不影响前两组属性，因此排在后面。

.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

与标签相比，@import 指令要慢很多，不光增加了额外的请求次数，还会导致不可预料的问题。替代办法有以下几种：

使用多个元素
通过 Sass 或 Less 类似的 CSS 预处理器将多个 CSS 文件编译为一个文件
通过 Rails、Jekyll 或其他系统中提供过 CSS 文件合并功能

<!-- Use link elements --><link rel="stylesheet" href="core.css"><!-- Avoid @imports --><style>  @import url("more.css");</style>

ログイン後にコピー

*********

媒体查询（Media query）的位置

将媒体查询放在尽可能相关规则的附近。不要将他们打包放在一个单一样式文件中或者放在文档底部。如果你把他们分开了，将来只会被大家遗忘。下面给出一个典型的实例。

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

ログイン後にコピー

*********

带前缀的属性

当使用特定厂商的带有前缀的属性时，通过缩进的方式，让每个属性的值在垂直方向对齐，这样便于多行编辑。

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

ログイン後にコピー

*********

单行规则声明

对于只包含一条声明的样式，为了易读性和便于快速编辑，建议将语句放在同一行。对于带有多条声明的样式，还是应当将声明分为多行。

这样做的关键因素是为了错误检测 -- 例如，CSS 校验器指出在 183 行有语法错误。如果是单行单条声明，你就不会忽略这个错误；如果是单行多条声明的话，你就要仔细分析避免漏掉错误了。

/* 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 的 heading 元素只需要设置上、下边距（margin）的值，因此，在必要的时候，只需覆盖这两个值就可以。过度使用简写形式的属性声明会导致代码混乱，并且会对属性值带来不必要的覆盖从而引起意外的副作用。这个问题我自身也经常犯，大家只能在实践中不断强化意识了。

/* 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）（不是下划线，也不是驼峰命名法）。破折号应当用于相关 class 的命名（类似于命名空间）（例如，.btn 和 .btn-danger）。
避免过度任意的简写。.btn 代表 button，但是 .s 不能表达任何意思。
class 名称应当尽可能短，并且意义明确。
使用有意义的名称。使用有组织的或目的明确的名称，不要使用表现形式（presentational）的名称。
基于最近的父 class 或基本（base） class 作为新 class 的前缀。
使用 .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 { ... }

ログイン後にコピー

*********