您的位置：首页 > 编程语言

黄金定律（永远遵循同一套规范）

2017-01-23 19:59 232 查看

编写灵活、稳定、高质量、干净的代码，不仅能体现你的个性，还能表现出你的才华，将才华表现在设计良好的结构和模式上，表现在对空间、代码的尊重上。记住：代码不是一次性的，需要不断的修改和重构，要写好代码需要一套适合自己的规范。

黄金定律-永远遵循同一套代码规范，不管有多少人共同参与同一个项目，一定要确保每一行代码像同一个人编写的。

尽量遵循HTML标准和语义，使用最少标签减小到最小复杂度，避免冗余。但不要以牺牲实用性为代价。

本文章摘自：http://codeguide.bootcss.com/

HTML规范

语法：

用两个空格来代替制表符（tab），这是唯一确保在不同环境下获得同一展现的方法。
嵌套元素应当缩进一次（两个空格）。
对属性的定义，确保全部用双引号，不用单引号。
不要在自闭合元素（单标签）尾部添加斜线。
有开必有合，不可省略结束标签（例如：</li></html>）。
为每个页面的第一行添加文档声明（!DOCTYPE），解析为标准模式。
为html根元素添加lang属性，从而为文档设置正确的语言。

例如：

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

IE兼容模式

IE浏览器通过<meta>元素来确定绘制当前页面所采用的IE版本，若非特殊要求，均设置为edge mode,确定采用IE的最新版本。

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

字符编码

通过明确的声明字符编码方式，确定页面的渲染方式。

<meta charset="utf-8">

引入CSS和Javascript文件

根据HTML5规范，在引入css、javascript文件时，一般无需指定type属性，text/css、text/javascript分别是它们的默认值。

<!--外部引入CSS文件-->
<link rel="stylesheet" href="xx.css">
<!--内部CSS-->
<style>
...
</style>
<!--引入js-->
<style>
...
</style>

属性顺序(提高易读性)

class
id、name
data-*
src、for、type、href、value
title、alt
role

class用于表示可复用组件，应放于第一位，id用于表示具体组件，应放于第二位。

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

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

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

关于布尔属性，有值表示true，没有值表示fale

CSS规范

语法

用两个空格来代替制表符（tab） -- 这是唯一能保证在所有环境下获得一致展现的方法。
为选择器分组时，将单独的选择器单独放在一行。
为了代码的易读性，在每个声明块的左花括号前添加一个空格。
声明块的右花括号应当单独成行。
每条声明语句的

后应该插入一个空格。
为了获得更准确的错误报告，每条声明都应该独占一行。
所有声明语句都应当以分号结尾。最后一条声明语句后面的分号是可选的，但是，如果省略这个分号，你的代码可能更易出错。
对于以逗号分隔的属性值，每个逗号后面都应该插入一个空格（例如，

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

当引入的CSS文件较多时，使用多个link标签。

带前缀的属性

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

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

单行规则声明

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

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

书写注释时，应当写明具体那里的注释，不要简单地会用CLASS名称。

class 命名

class 名称中只能出现小写字符和破折号（dashe）（不是下划线，也不是驼峰命名法）。破折号应当用于相关 class 的命名（类似于命名空间）（例如，

.btn

和

.btn-danger

）。
避免过度任意的简写。

.btn

代表 button，但是

.s

不能表达任何意思。
class 名称应当尽可能短，并且意义明确。
使用有意义的名称。使用有组织的或目的明确的名称，不要使用表现形式（presentational）的名称。
基于最近的父 class 或基本（base） class 作为新 class 的前缀。
使用

.js-*

class 来标识行为（与样式相对），并且不要将这些 class 包含到 CSS
文件中。

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

编辑器配置

将你的编辑器按照下面的配置进行设置，以避免常见的代码不一致和差异：
用两个空格代替制表符（soft-tab 即用空格代表 tab 符）。
保存文件时，删除尾部的空白符。
设置文件编码为 UTF-8。
在文件结尾添加一个空白行。

Javascript

后续更新...

内容来自用户分享和网络整理，不保证内容的准确性，如有侵权内容，可联系管理员处理

标签： 编程规范

相关文章推荐

新的分享

章节导航