집 > 기사 > 웹 프론트엔드 > HTML CSS 코딩 표준(황금률)

HTML CSS 코딩 표준(황금률)

WBOY원래의: 2016-10-22 11:56:251096검색

HTML

구문

탭 대신 공백 두 개를 사용하세요. 이는 모든 환경에서 일관된 표시를 보장하는 유일한 방법입니다. </li>
중첩된 요소는 한 번 들여쓰기해야 합니다(예: 공백 2개). </li>
속성 정의에는 큰따옴표를 사용하고 작은따옴표는 사용하지 마세요. </li>
자체 닫는 요소에 후행 슬래시를 추가하지 마세요. HTML5 사양에서는 이것이 선택 사항이라고 명시적으로 명시하고 있습니다. </li>
선택적인 닫는 태그(예: </li> 또는 </body>)를 생략하지 마세요. </li>

<code><!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>
</code>

HTML5 문서 유형

각 HTML 페이지의 첫 번째 줄에 표준 모드 선언을 추가하여 각 브라우저에서 일관된 표시를 보장합니다.

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

언어 속성

HTML5 사양에 따르면:

문서에 올바른 언어를 설정하려면 html 루트 요소에 lang 속성을 지정하는 것이 좋습니다. 이는 음성 합성 도구가 사용해야 하는 발음을 결정하고 번역 도구가 번역할 때 따라야 하는 규칙을 결정하는 데 도움이 됩니다.

lang 속성에 대한 자세한 내용은 이 사양에서 확인할 수 있습니다.

언어 코드 목록은 여기에 나열되어 있습니다.

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

IE 호환 모드

IE는 현재 페이지를 그리는 데 사용해야 하는 IE 버전을 결정하기 위해 특정 <meta> 태그를 지원합니다. 특별히 필요한 경우가 아니라면 에지 모드로 설정하여 IE가 지원하는 최신 모드를 채택하도록 알리는 것이 가장 좋습니다.

더 유용한 정보를 보려면 이 스택 오버플로 기사를 읽어보세요.

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

문자 인코딩

문자 인코딩을 명시적으로 선언하면 브라우저가 페이지 콘텐츠를 렌더링하는 방법을 빠르고 쉽게 결정하도록 할 수 있습니다. 이것의 장점은 HTML에서 문자 엔터티를 사용하지 않아도 되므로 모든 것이 문서 인코딩(보통 UTF-8 인코딩)과 일치한다는 것입니다.

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

CSS 및 JavaScript 파일 소개

HTML5 사양에 따르면 일반적으로 CSS 및 JavaScript 파일을 도입할 때 type 속성을 지정할 필요가 없습니다. 각각 text/css 및 text/javascript이 기본값이기 때문입니다.

HTML5 사양 링크

링크 이용하기 </li>
스타일 사용 </li>
스크립트 사용</li>

<code><!-- External CSS -->
<link rel="stylesheet" href="code-guide.css">

<!-- In-document CSS -->
<style>
  /* ... */
</style>

<!-- JavaScript -->
<script src="code-guide.js"></script>
</code>

실용성이 왕입니다

HTML 표준과 의미를 따르되 실용성을 희생하지 마세요. 항상 최소한의 태그를 사용하고 복잡성을 최소화하도록 노력하세요.

속성 순서

코드의 가독성을 보장하려면 HTML 속성을 아래 순서대로 정렬해야 합니다.

class </li>
id, name </li>
data-* </li>
src, for, type, href </li>
title, alt </li>
aria-*, role </li>

클래스는 재사용 가능성이 높은 구성 요소를 식별하는 데 사용되므로 먼저 나열해야 합니다. ID는 특정 구성 요소를 식별하는 데 사용되며 주의해서 사용해야 합니다(예: 페이지 내의 책갈피). 따라서 두 번째로 사용됩니다.

<code><a class="..." id="..." data-modal="toggle" href="#">
  Example link
</a>

<input class="form-control" type="text">

<img src="..." alt="...">
</code>

부울 속성

부울 속성은 값을 할당하지 않고 선언할 수 있습니다. XHTML 사양에서는 값을 할당해야 하지만 HTML5 사양에서는 그렇지 않습니다.

자세한 내용은 부울 속성에 대한 WhatWG 섹션을 참조하세요.

요소의 Boolean 속성에 값이 있으면 true이고, 값이 없으면 false입니다.

에 값을 할당해야 하는 경우 WhatWG 사양을 참조하세요.

속성이 존재하는 경우 해당 값은 빈 문자열이거나 [...] 속성의 정식 이름이어야 하며 후행 공백을 추가하지 마세요.

간단히 말하면 값을 지정할 필요가 없습니다.

<code><input type="text" disabled>

<input type="checkbox" value="1" checked>

<select>
  <option value="1" selected>1</option>
</select>
</code>

태그 수 줄이기

HTML 코드를 작성할 때 중복되는 상위 요소를 피하십시오. 이를 달성하려면 반복과 리팩토링이 필요한 경우가 많습니다. 아래 사례를 참고해주세요:

<code><!-- Not so great -->
<span class="avatar">
  <img src="...">
</span>

<!-- Better -->
<img class="avatar" src="...">
</code>

JavaScript 생성 태그

JavaScript를 통해 생성된 태그는 콘텐츠 찾기, 편집을 어렵게 만들고 성능을 저하시킵니다. 가능하면 피하세요.

CSS

语法

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

对于这里用到的术语有疑问吗？请参考 Wikipedia 上的 syntax section of the Cascading Style Sheets article。

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

声明顺序

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

Positioning </li>
Box model </li>
Typographic </li>
Visual</li>

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

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

完整的属性列表及其排列顺序请参考 Recess。

<code>.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;
}
</code>

不要使用 `@import`

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

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

请参考 Steve Souders 的文章了解更多知识。

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

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

媒体查询（Media query）的位置

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

<code>.element { ... }
.element-avatar { ... }
.element-selected { ... }

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

带前缀的属性

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

在 Textmate 中，使用 Text → Edit Each Line in Selection(⌃⌘A)。在 Sublime Text 2 中，使用 Selection → Add Previous Line (⌃⇧↑) 和 Selection → Add Next Line (⌃⇧↓)。

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

单行规则声明

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

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

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

简写形式的属性声明

在需要显示地设置所有值的情况下，应当尽量限制使用简写形式的属性声明。常见的滥用简写属性声明的情况如下：

padding </li>
margin </li>
font </li>
background </li>
border </li>
border-radius</li>

大部分情况下，我们不需要为简写形式的属性声明指定所有值。例如，HTML 的 heading 元素只需要设置上、下边距（margin）的值，因此，在必要的时候，只需覆盖这两个值就可以。过度使用简写形式的属性声明会导致代码混乱，并且会对属性值带来不必要的覆盖从而引起意外的副作用。

MDN（Mozilla Developer Network）上一片非常好的关于shorthand properties 的文章，对于不太熟悉简写属性声明及其行为的用户很有用。

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

Less 和 Sass 中的嵌套

避免非必要的嵌套。这是因为虽然你可以使用嵌套，但是并不意味着应该使用嵌套。只有在必须将样式限制在父元素内（也就是后代选择器），并且存在多个需要嵌套的元素时才使用嵌套。

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

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

注释

代码是由人编写并维护的。请确保你的代码能够自描述、注释良好并且易于他人理解。好的代码注释能够传达上下文关系和代码目的。不要简单地重申组件或 class 名称。

对于较长的注释，务必书写完整的句子；对于一般性注解，可以书写简洁的短语。

<code>/* Bad example */
/* Modal header */
.modal-header {
  ...
}

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

class 命名

class 名称中只能出现小写字符和破折号（dashe）（不是下划线，也不是驼峰命名法）。破折号应当用于相关 class 的命名（类似于命名空间）（例如，.btn 和 .btn-danger）。 </li>
避免过度任意的简写。.btn 代表 button，但是 .s 不能表达任何意思。 </li>
class 名称应当尽可能短，并且意义明确。 </li>
使用有意义的名称。使用有组织的或目的明确的名称，不要使用表现形式（presentational）的名称。 </li>
基于最近的父 class 或基本（base） class 作为新 class 的前缀。 </li>
使用 .js-* class 来标识行为（与样式相对），并且不要将这些 class 包含到 CSS 文件中。</li>

在为 Sass 和 Less 变量命名是也可以参考上面列出的各项规范。

<code>/* Bad example */
.t { ... }
.red { ... }
.header { ... }

/* Good example */
.tweet { ... }
.important { ... }
.tweet-header { ... }
</code>

选择器

对于通用元素使用 class ，这样利于渲染性能的优化。 </li>
对于经常出现的组件，避免使用属性选择器（例如，[class^="..."]）。浏览器的性能会受到这些因素的影响。 </li>
选择器要尽可能短，并且尽量限制组成选择器的元素个数，建议不要超过 3 。 </li>
只有在必要的时候才将 class 限制在最近的父元素内（也就是后代选择器）（例如，不使用带前缀的 class 时 -- 前缀类似于命名空间）。</li>

扩展阅读：

Scope CSS classes with prefixes </li>
Stop the cascade</li>

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

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

代码组织

以组件为单位组织代码段。 </li>
制定一致的注释规范。 </li>
使用一致的空白符将代码分隔成块，这样利于扫描较大的文档。 </li>
如果使用了多个 CSS 文件，将其按照组件而非页面的形式分拆，因为页面会被重组，而组件只会被移动。</li>

<code>/*
 * 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 { ... }
</code>

编辑器配置

将你的编辑器按照下面的配置进行设置，以避免常见的代码不一致和差异：

用两个空格代替制表符（soft-tab 即用空格代表 tab 符）。 </li>
保存文件时，删除尾部的空白符。 </li>
设置文件编码为 UTF-8。 </li>
在文件结尾添加一个空白行。</li>

성명：

이전 기사：Sass의 중국 문제다음 기사：Sass의 중국 문제