• CSS规范


    一、语法

    1.1 注意

    (1)用两个空格来代替制表符(tab) -- 这是唯一能保证在所有环境下获得一致展现的方法。

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

    (3)为了代码的易读性,在每个声明块的左花括号前添加一个空格。

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

    (5)每条声明语句之后应该插入一个空格。

    (6)为了获得更准确的错误报告,每条声明都应该独占一行。

    (7)所有声明语句都应当以分号结尾。最后一条声明语句后面的分号是可选的,但是,如果省略这个分号,你的代码可能更易出错。

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

    (9)不要在 rgb()rgba()hsl()hsla() 或 rect() 值的内部的逗号后面插入空格。这样利于从多个属性值(既加逗号也加空格)中区分多个颜色值(只加逗号,不加空格)。

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

    (11)十六进制值应该全部小写,例如,#fff。在扫描文档时,小写字符易于分辨,因为他们的形式更易于区分。

    (12)尽量使用简写形式的十六进制值,例如,用 #fff代替 #ffffff

    (13)为选择器中的属性添加双引号,例如,input[type="text"]。只有在某些情况下是可选的,但是,为了代码的一致性,建议都加上双引号。

    (14)避免为 0 值指定单位,例如,用 margin: 0; 代替 margin: 0px;

    1.2 Example

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

    二、声明顺序

    2.1 相关属性一组

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

    (1)Positioning

    (2)Box model

    (3)Typographic

    (4)Visual

    2.2 说明

    (1)由于定位(positioning)可以从正常的文档流中移除元素,并且还能覆盖盒模型(box model)相关的样式,因此排在首位。

    (2)盒模型排在第二位,因为它决定了组件的尺寸和位置。

    (3)其他属性只是影响组件的内部(inside)或者是不影响前两组属性,因此排在后面。

    2.3 Example

    .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;
    
        /* Typographt*/
        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

    3.1 不用原因

    与 <link> 标签相比,@import 指令要慢很多,不光增加了额外的请求次数,还会导致不可预料的问题。

    3.2替代方法

    (1)使用多个 <link> 元素

    (2)通过 Sass 或 Less 类似的 CSS 预处理器将多个 CSS 文件编译为一个文件

    (3)通过 Rails、Jekyll 或其他系统中提供过 CSS 文件合并功能

    3.3 Example

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

    四、媒体查询(Media query)的位置

    4.1 相关规则附近

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

    4.2 Example

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

    五、带前缀的属性

    5.1 垂直对齐

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

    5.2 Example

    .selector {
        -wenlot-box-shadow: 0 1px 2px rgba(0, 0, 0, .15);
                     box-shadow: 0 1px 2px rgba(0, 0, 0, .15);
    }    

    六、单行规则声明

    6.1 放在一行

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

    6.2 错误检测

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

    6.3 Example

    /* Single declarations on one line*/
    .sapn1 { width: 60px; }
    .sapn2 { width: 60px; }
    .sapn3 { width: 60px; }
    
    /* Single 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;}

    七、简写形式的属性声明

    7.1 滥用简写

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

    (1)padding

    (2)margin

    (3)font

    (4)background

    (5)border

    (5)border-radius

    7.2 说明

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

    7.3 Example

    /* 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 中的嵌套

    8.1 尽量不嵌套

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

    8.2 Example

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

    九、Less 和 Sass 中的操作符

    为了提高可读性,在圆括号中的数学计算表达式的数值、变量和操作符之间均添加一个空格。

    /* Bad example*/
    .emelent {
        margin: 10px 0 @variable*2 10px;
    }
    
    /* Goodexample*/
    .emelent {
        margin: 10px 0 (@variable * 2) 10px;
    }

    十、注释

    10.1 注意

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

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

    10.2 Example

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

    十一、class 命名

    11.1 规范

    (1)class 名称中只能出现小写字符和破折号(dashe)(不是下划线,也不是驼峰命名法)。破折号应当用于相关 class 的命名(类似于命名空间)(例如,.btn 和 .btn-danger)。

    (2)避免过度任意的简写。.btn 代表 button,但是 .s 不能表达任何意思。

    (3)class 名称应当尽可能短,并且意义明确。

    (4)使用有意义的名称。使用有组织的或目的明确的名称,不要使用表现形式(presentational)的名称。

    (5)基于最近的父 class 或基本(base) class 作为新 class 的前缀。

    (6)使用 .js-* class 来标识行为(与样式相对),并且不要将这些 class 包含到 CSS 文件中。

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

    11.2 Example

    /* Bad example*/
    .t { ... }
    .red { ... }
    .header { ... }
    
    /* Good example*/
    .tweet { ... }
    .important{ ... }
    .tweet-header{ ... }

    十二、选择器

    12.1 注意

    (1)对于通用元素使用 class ,这样利于渲染性能的优化。

    (2)对于经常出现的组件,避免使用属性选择器(例如,[class^="..."])。浏览器的性能会受到这些因素的影响。

    (3)选择器要尽可能短,并且尽量限制组成选择器的元素个数,建议不要超过 3 。

    (4)只有在必要的时候才将 class 限制在最近的父元素内(也就是后代选择器)(例如,不使用带前缀的 class 时 -- 前缀类似于命名空间)。

    12.2 Example

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

    十三、代码组织

    13.1 注意

    (1)以组件为单位组织代码段。

    (2)制定一致的注释规范。

    (3)使用一致的空白符将代码分隔成块,这样利于扫描较大的文档。

    (4)如果使用了多个 CSS 文件,将其按照组件而非页面的形式分拆,因为页面会被重组,而组件只会被移动。

    13.2 Example

    /*
    * Component section heading
    */
    
    .element { ... }
    
    
    /*
    * Component section heading
    *
    * Sometimes you need to include potional context for the entire compent. Do that up here if it's important enough.
    */
    
    .element { ... }
    
    /* Contextual sub-component or modifer*/
    .element-heading { ... }

    十四、编辑器配置

    14.1 避免代码不同

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

    (1)用两个空格代替制表符(soft-tab 即用空格代表 tab 符)。

    (2)保存文件时,删除尾部的空白符。

    (3)设置文件编码为 UTF-8。

    (4)在文件结尾添加一个空白行

  • 相关阅读:
    在受identityServer4保护的子站点里获得accesstoken的方法
    identity server4 在接入时遇到错误:Exception: Correlation failed. Unknown location的解决方法
    .net core3.1发布时使用https的方式的记录
    调用identityServer4服务端的自定义api接口
    identity server4里遇到:User name '' is invalid, can only contain letters or digits的解决方式
    访问github
    接口幂等性
    类型“any[]”的参数不能赋给类型“SetStateAction<never[]>”的参数。
    什么是VUEX?
    获取Google、Github Oauth ClientID
  • 原文地址:https://www.cnblogs.com/wuxu-dl/p/14648356.html
Copyright © 2020-2023  润新知