Less 编码规范 (1.1)

简介

该文档主要的设计目标是提高 Less 文档的团队一致性与可维护性。

Less 代码的基本规范和原则与 CSS 编码规范 保持一致。

编撰

erik、顾轶灵、黄后锦、李玉北、赵雷。

本文档由商业运营体系前端技术组审校发布。

要求

在本文档中，使用的关键字会以中文+括号包含的关键字英文表示：必须（MUST）。关键字”MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL”被定义在rfc2119中。

编码

使用UTF-8编码。不得（MUST NOT）包含BOM信息。

代码组织

代码必须（MUST）按如下形式按顺序组织：

  1. @import
  2. 变量声明
  3. 样式声明
  1. // ✓
  2. @import "est/all.less";
  4. @default-text-color: #333;
  6. .page {
  7.     width: 960px;
  8.     margin: 0 auto;
  9. }

@import 语句

@import 语句引用的文件必须（MUST）写在一对引号内，.less 后缀不得（MUST NOT）省略（与引入 CSS 文件时的路径格式一致）。引号使用 ' 和 " 均可，但在同一项目内必须（MUST）统一。

  1. // ✗
  2. @import 'est/all';
  3. @import "my/mixins.less";
  5. // ✓
  6. @import "est/all.less";
  7. @import "my/mixins.less";

空格

属性、变量

选择器和 { 之间必须（MUST）保留一个空格。

属性名后的冒号（:）与属性值之间必须（MUST）保留一个空格，冒号前不得（MUST NOT）保留空格。

定义变量时冒号（:）与变量值之间必须（MUST）保留一个空格，冒号前不得（MUST NOT）保留空格。

在用逗号（,）分隔的列表（Less 函数参数列表、以 , 分隔的属性值等）中，逗号后必须（MUST）保留一个空格，逗号前不得（MUST NOT）保留空格。

  1. // ✗
  2. .box{
  3.     @w:50px;
  4.     @h :30px;
  5.     width:@w;
  6.     height :@h;
  7.     color: rgba(255,255,255,.3);
  8.     transition: width 1s,height 3s;
  9. }
  11. // ✓
  12. .box {
  13.     @w: 50px;
  14.     @h: 30px;
  15.     width: @w;
  16.     height: @h;
  17.     transition: width 1s, height 3s;
  18. }

运算

+ / - / * / / 四个运算符两侧必须（MUST）保留一个空格。+ / - 两侧的操作数必须（MUST）有相同的单位，如果其中一个是变量，另一个数值必须（MUST）书写单位。

  1. // ✗
  2. @a: 200px;
  3. @b: (@a+100)*2;
  5. // ✓
  6. @a: 200px;
  7. @b: (@a + 100px) * 2;

混入（Mixin）

Mixin 和后面的空格之间不得（MUST NOT）包含空格。在给 mixin 传递参数时，在参数分隔符（, / ;）后必须（MUST）保留一个空格：

  1. // ✗
  2. .box {
  3.     .size(30px,20px);
  4.     .clearfix ();
  5. }
  7. // ✓
  8. .box {
  9.     .size(30px, 20px);
  10.     .clearfix();
  11. }

选择器

当多个选择器共享一个声明块时，每个选择器声明必须（MUST）独占一行。

  1. // ✗
  2. h1, h2, h3 {
  3.     font-weight: 700;
  4. }
  6. // ✓
  7. h1,
  8. h2,
  9. h3 {
  10.     font-weight: 700;
  11. }

Class 命名不得以样式信息进行描述，如 .float-right、text-red 等。

省略与缩写

缩写

多个属性定义可以使用缩写时， 尽量（SHOULD）使用缩写。缩写更清晰字节数更少。常见缩写有 margin、border、padding、font、list-style 等。在书写时必须（MUST）考量缩写展开后是否有不需要覆盖的属性内容被修改，从而带来副作用。

数值

对于处于 (0, 1) 范围内的数值，小数点前的 0 可以（MAY）省略，同一项目中必须（MUST）保持一致。

  1. // ✗
  2. transition-duration: 0.5s, .7s;
  4. // ✓
  5. transition-duration: .5s, .7s;

0 值

当属性值为 0 时，必须（MUST）省略可省的单位（长度单位如 px、em，不包括时间、角度等如 s、deg）。

  1. // ✗
  2. margin-top: 0px;
  4. // ✓
  5. margin-top: 0;

颜色

颜色定义必须（MUST）使用 #rrggbb 格式定义，并在可能时尽量（SHOULD）缩写为 #rgb 形式，且避免直接使用颜色名称与 rgb() 表达式。

  1. // ✗
  2. border-color: red;
  3. color: rgb(254, 254, 254);
  5. // ✓
  6. border-color: #f00;
  7. color: #fefefe;

私有属性前缀

同一属性有不同私有前缀的，尽量（SHOULD）按前缀长度降序书写，标准形式必须（MUST）写在最后。且这一组属性以第一条的位置为准，尽量（SHOULD）按冒号的位置对齐。

  1. // ✓
  2. .box {
  3.     -webkit-transform: rotate(30deg);
  4.        -moz-transform: rotate(30deg);
  5.         -ms-transform: rotate(30deg);
  6.          -o-transform: rotate(30deg);
  7.             transform: rotate(30deg);
  8. }

其他

可以（MAY）在无其他更好解决办法时使用 CSS hack，并且尽量（SHOULD）使用简单的属性名 hack 如 _zoom、*margin。

可以（MAY）但谨慎使用 IE 滤镜。需要注意的是，IE 滤镜中图片的 URL 是以页面路径作为相对目录，而不是 CSS 文件路径。

嵌套和缩进

必须（MUST）采用 4 个空格为一次缩进， 不得（MUST NOT）采用 TAB 作为缩进。

嵌套的声明块前必须（MUST）增加一次缩进，有多个声明块共享命名空间时尽量（SHOULD）嵌套书写，避免选择器的重复。

但是需注意的是，尽量（SHOULD）仅在必须区分上下文时才引入嵌套关系（在嵌套书写前先考虑如果不能嵌套，会如何书写选择器）。

  1. // ✗
  2. .main .title {
  3.   font-weight: 700;
  4. }
  6. .main .content {
  7.   line-height: 1.5;
  8. }
  10. .main {
  11. .warning {
  12.   font-weight: 700;
  13. }
  15.   .comment-form {
  16.     #comment:invalid {
  17.       color: red;
  18.     }
  19.   }
  20. }
  22. // ✓
  23. .main {
  24.     .title {
  25.         font-weight: 700;
  26.     }
  28.     .content {
  29.         line-height: 1.5;
  30.     }
  32.     .warning {
  33.         font-weight: 700;
  34.     }
  35. }
  37. #comment:invalid {
  38.     color: red;
  39. }

变量

Less 的变量值总是以同一作用域下最后一个同名变量为准，务必注意后面的设定会覆盖所有之前的设定。

变量命名必须（MUST）采用 @foo-bar 形式，不得（MUST NOT）使用 @fooBar 形式。

  1. // ✗
  2. @sidebarWidth: 200px;
  3. @width:800px;
  5. // ✓
  6. @sidebar-width: 200px;
  7. @width: 800px;

继承

使用继承时，如果在声明块内书写 :extend 语句，必须（MUST）写在开头：

  1. // ✗
  2. .sub {
  3.     color: red;
  4.     &:extend(.mod all);
  5. }
  7. // ✓
  8. .sub {
  9.     &:extend(.mod all);
  10.     color: red;
  11. }

混入（Mixin）

在定义 mixin 时，如果 mixin 名称不是一个需要使用的 className，必须（MUST）加上括号，否则即使不被调用也会输出到 CSS 中。

  1. // ✗
  2. .big-text {
  3.     font-size: 2em;
  4. }
  6. h3 {
  7.     .big-text;
  8. }
  10. // ✓
  11. .big-text() {
  12.     font-size: 2em;
  13. }
  15. h3 {
  16.     .big-text();
  17. }

如果混入的是本身不输出内容的 mixin，必须（MUST）在 mixin 后添加括号（即使不传参数），以区分这是否是一个 className（修改以后是否会影响 HTML）。

  1. // ✗
  2. .box {
  3.     .clearfix;
  4.     .size (20px);
  5. }
  7. // ✓
  8. .box {
  9.     .clearfix();
  10.     .size(20px);
  11. }

Mixin 的参数分隔符使用 , 和 ; 均可，但在同一项目中必须（MUST）保持统一。

命名空间

变量和 mixin 在命名时必须（MUST）遵循如下原则：

  • 一个项目只能引入一个无命名前缀的基础样式库（如 est）
  • 业务代码和其他被引入的样式代码中，变量和 mixin 必须有项目或库的前缀

字符串

在进行字符串转义时，使用 ~"" 表达式与 e() 函数均可，但在同一项目中必须（MUST）保持一致。

字符串两侧的引号必须（MUST）使用 "。

JS 表达式

可以（MAY）使用 JS 表达式（~``）生成属性值或变量，其中包含的字符串两侧的引号尽量（SHOULD）使用单引号（'）。

注释

单行注释尽量（SHOULD）使用 // 方式。

  1. // Hide everything
  2. * {
  3.     display: none;
  4. }