编码规范

Posted homehtml

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了编码规范相关的知识,希望对你有一定的参考价值。

黄金定律

不管有多少人共同参与同一项目,一定要确保每一行代码都像是同一个人编写的。

html

1.语法

1).用两个空格代表制表符

2).嵌套元素应当缩进一次(两个空格)

3).对于属性的定义,用双引号

4).不在自闭合元素的尾部加斜线

2.HTML5 doctype

在每个html页面第一行添加标准模式的声明,确保在每一个浏览器拥有一致的展现。

<!DOCTYPE html>

3.语言属性

强烈建议为html根元素指定lang属性,从而为文档设置正确的语言。这将有助于语言合成工具确定所应该采用的发音,有助于翻译工具确定其翻译时所应遵守的规则等等。

<html lang=‘en‘>
</html>

4.IE兼容模式

IE 支持通过特定的 <meta> 标签来确定绘制当前页面所应该采用的 IE 版本。除非有强烈的特殊需求,否则最好是设置为 edge mode,从而通知 IE 采用其所支持的最新的模式。

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

5.字符编码

<meta charset="UTF-8">

6.引入 CSS 和 javascript 文件

在引入 CSS 和 JavaScript 文件时一般不需要指定 type 属性

7.实用为王

任何时候都要尽量使用最少的标签并保持最小的复杂度。

8.属性顺序

  • class
  • id, name
  • data-*
  • src, for, type, href, value
  • title, alt
  • role, aria-*

9.布尔(boolean)型属性

不用赋值。

<input type="text" disabled>

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

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

10.减少标签的数量

尽量避免多余的父元素。

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

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

11.JavaScript 生成的标签

能避免时尽量避免。

CSS

1.语法

1).用两个空格代替制表符

2).为选择器分组时,将单独的选择器单独放在一行。

3).在每个声明块的左花括号前添加一个空格。

4).声明块的右花括号应当单独成行。

5).每条声明语句的 : 后应该插入一个空格。

6).每条声明都应该独占一行。

7).对于以逗号分隔的属性值,每个逗号后面都应该插入一个空格(例如,box-shadow)。

8).不要在 rgb()、rgba()、hsl()、hsla() 或 rect() 值的内部的逗号后面插入空格。

9).对于属性值或颜色参数,省略小于 1 的小数前面的 0 (例如,.5 代替 0.5;-.5px 代替 -0.5px)。

10).十六进制值应该全部小写,尽量使用简写形式的十六进制值。例如:#fff

11).为选择器中的属性添加双引号,例如,input[type="text"]。

12).避免为 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;
}

2.声明顺序

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

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

3.不要使用 @import

与 <link> 标签相比,@import 指令要慢很多

解决办法:

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

4.媒体查询(Media query)的位置

不要把他们打包放在一个单一样式文件中或者放在文档底部,应放在尽可能相关规则的附近。

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

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

5.带前缀的属性

通过缩进的方式,让每个属性的值在垂直方向对齐,这样便于多行编辑。

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

6.单行规则声明

对于只包含一条声明的样式,建议将语句放在同一行。

7.简写形式的属性声明

应当尽量限制使用简写形式的属性声明。常见的滥用简写属性声明的情况如下:

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

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

8.Less 和 Sass 中的嵌套

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

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

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

9.Less 和 Sass 中的操作符

在圆括号中的数学计算表达式的数值、变量和操作符之间均添加一个空格。

10.注释

不要简单地重申组件或 class 名称。

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

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

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

11.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 { ... }
    

12.选择器

  • 对于通用元素使用 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 { ... }
    

13.代码组织

  • 以组件为单位组织代码段。
  • 制定一致的注释规范。
  • 使用一致的空白符将代码分隔成块,这样利于扫描较大的文档。
  • 如果使用了多个 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 { ... }

14.编辑器配置

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

  • 用两个空格代替制表符(soft-tab 即用空格代表 tab 符)。
  • 保存文件时,删除尾部的空白符。
  • 设置文件编码为 UTF-8。
  • 在文件结尾添加一个空白行。

以上是关于编码规范的主要内容,如果未能解决你的问题,请参考以下文章

php Yoast SEO规范输出的代码片段

在 Java 中规范化可能编码的 URI 字符串

SQL记录-PLSQL包

markdown 打字稿...编码说明,提示,作弊,指南,代码片段和教程文章

编码规范篇| C#编码规范 代码规范总结,包括命名规范,代码规范 注释规范等

PL/SQL包(package)操作实例讲解