您好, 欢迎来到 !    登录 | 注册 | | 设为首页 | 收藏本站

Sass 注释

本节我们将讲解 Sass 中的单行注释和多行注释,以及 Sass 注释的书写规范,良好的注释习惯可以让我们的更容易维护,让接手我们的合作者更高效。

注释就是说你可以在中以特定的方式为注解,每种编程语言都拥有自己的注释方式,在 Sass 中也不例外,注释可以让我们为重要的注解以方便我们和者查阅。

在 Sass 中的任何地方你都可以编写一段注释,Sass 标准的 CSS 单行注释(//)和多行注释(/* */),我们接下来就看看它们的使用。

单行注释是在 // 后面跟你的注释,直到行尾,要记住 Sass 中的单行注释不会被编译到 CSS 中,也就是说在转换为 CSS 后,是不会包含你写的单行注释的!我们举个例子来看下:

// This is a comments
// This is a comments
.@R_118_2@2 {
  width: px;
  height: px;
  p {
    color: red
  }
  .main {
    width: ;
  }
}

上面的为 CSS 如下:

.@R_118_2@2 {
  width: px;
  height: px;
}
.@R_118_2@2 p {
  color: red;
}
.@R_118_2@2 .main {
  width: ;
}

从上面的中我们可以看出,转换为 CSS 后我们在 Sass 中写的单行注释消失了。

多行注释是在 /* */ 的两个星号中间来编写注释,以 /* 开头,换行的话每一行都以 * 号开头,最终以 */ 结尾,多行注释是会被编译到 CSS 中的,并且在多行注释中我们可以使用插值,如果你忘记了什么是插值,赶快复习一下前面的 Sass 插值章节。下面我们举例看下多行注释:

/* This is a comment
 * contain interpolation:
 * 1 + 1 = #{1 + 1}
 * 8 * 8 = #{8 * 8}
 */
.@R_118_2@2 {
  width: px;
  height: px;
  p {
    color: red
  }
  .main {
    width: ;
    heigth: auto
  }
}

上面的为 CSS 如下:

/* This is a comment
 * contain interpolation:
 * 1 + 1 = 2
 * 8 * 8 = 64
 */
.@R_118_2@2 {
  width: px;
  height: px;
}
.@R_118_2@2 p {
  color: red;
}
.@R_118_2@2 .main {
  width: ;
  heigth: auto;
}

通过上面的可以看出,多行注释最终将会被编译为 CSS 的多行注释并带到 CSS 中去,而且在多行注释中可以使用插值来进行一些运算。

在认的情况下,如果处于压缩模式,则转换后的 CSS 中也是不包含多行注释的,如果你忘了什么是压缩模式,赶快复习下 Sass 格式章节。所以我们可以通过以 /*! 开头,来保证多行注释在任何模式下都会被转换为 CSS 。我们举例看下:

/*! This comment will be 
* included even in every mode. */
.@R_118_2@2 {
  width: px;
  height: px;
  p {
    color: red
  }
  .main {
    width: ;
    heigth: auto
  }
}

通过上面这种注释方式就可以保证你的注释在任何模式下都会被。

在 Sass 中书写注释首先要记住,要根据情况来选择你使用上面哪种注释方式,其余的一些注释规范不同的团队可能有不同的标准,遵循你的团队的规范即可。如果没有的话你可以遵照 CSS 的注释规范,同时我们的项目中不允许使用 /*! */ 的方式注释,因为我们要确保压缩版的 CSS 中是不包含任何注释的!

我这里写出一些我们的注释书写规范:

除了上面这些规范我们还要求在每个的头部注释当前的创建时间、作者和对于当前的描述,就如同下面这样:

/*
* Auth: ElvisYang
* Date: Mar 22 2018
* Desc: This is common scss
*/
.edit-price {
  .label {
    width: px;
    text-align: right;
  }
}

上面这种方式可以让别人打开就清楚的看见的描述和作者,所以这个也纳入了我们的注释规范中,这种注释你可以通过设置你的 IDE 来。

在实际的项目中注释是必不可少的,在任何语言中都一样。 Sass 作为一门 CSS 扩展语言,在实际项目中会定义很多、mixin 和变量等,所以你必须为它们编写合理的注释,这样方便你自己或者其他人后期的维护,而且压缩格式我们一般都是不带注释的 CSS 的。

除此之外需要注意遵循团队的注释规范,一般规范都由团队的 leader 或架构师来制定,如果你的项目中没有制定这些规范,请遵循 CSS 的注释规范或者业界通用的规范,当然你也可以选择我前面列出来的规范。总之要记住,注释和一样重要!

本节我们讲解了 Sass 中注释的使用方式和注释的书写规范,在 Sass 中有单行注释和多行注释,单行注释不会到 CSS 中,多行注释可以到 CSS 中,此外在多行注释中还可以使用插值。编写一手简单、易懂的注释是优秀程序员的基本素养,会为你的加分,在你的 Sass 中灵活的应用注释吧!


联系我
置顶