通用约定

代码组织

  • 以组件为单位组织代码段;
  • 制定一致的注释规范;
  • 组件块和子组件块以及声明块之间使用一空行分隔,子组件块之间三空行分隔;
  • 如果使用了多个 CSS 文件,将其按照组件而非页面的形式分拆,因为页面会被重组,而组件只会被移动;

良好的注释是非常重要的。请留出时间来描述组件(component)的工作方式、局限性和构建它们的方法。不要让你的团队其它成员 来猜测一段不通用或不明显的代码的目的。

提示:通过配置编辑器,可以提供快捷键来输出一致认可的注释模式。

  1. /* ==========================================================================
  2. 组件块
  3. ============================================================================ */
  4. /* 子组件块
  5. ============================================================================ */
  6. .selector {
  7. padding: 15px;
  8. margin-bottom: 15px;
  9. }
  10. /* 子组件块
  11. ============================================================================ */
  12. .selector-secondary {
  13. display: block; /* 注释*/
  14. }
  15. .selector-three {
  16. display: span;
  17. }

Class 和 ID

  • 使用语义化、通用的命名方式;
  • 使用连字符 - 作为 ID、Class 名称界定符,不要驼峰命名法和下划线;
  • 避免选择器嵌套层级过多,尽量少于 3 级;
  • 避免选择器和 Class、ID 叠加使用;

出于性能考量,在没有必要的情况下避免元素选择器叠加 Class、ID 使用。

元素选择器和 ID、Class 混合使用也违反关注分离原则。如果HTML标签修改了,就要再去修改 CSS 代码,不利于后期维护。

  1. /* Not recommended */
  2. .red {}
  3. .box_green {}
  4. .page .header .login #username input {}
  5. ul#example {}
  6. /* Recommended */
  7. #nav {}
  8. .box-video {}
  9. #username input {}
  10. #example {}

声明块格式

  • 选择器分组时,保持独立的选择器占用一行;
  • 声明块的左括号 { 前添加一个空格;
  • 声明块的右括号 } 应单独成行;
  • 声明语句中的 : 后应添加一个空格;
  • 声明语句应以分号 ; 结尾;
  • 一般以逗号分隔的属性值,每个逗号后应添加一个空格;
  • rgb()rgba()hsl()hsla()rect() 括号内的值,逗号分隔,但逗号后不添加一个空格;
  • 对于属性值或颜色参数,省略小于 1 的小数前面的 0 (例如,.5 代替 0.5-.5px 代替 -0.5px);
  • 十六进制值应该全部小写和尽量简写,例如,#fff 代替 #ffffff
  • 避免为 0 值指定单位,例如,用 margin: 0; 代替 margin: 0px;
  1. /* Not recommended */
  2. .selector, .selector-secondary, .selector[type=text] {
  3. padding:15px;
  4. margin:0px 0px 15px;
  5. background-color:rgba(0, 0, 0, 0.5);
  6. box-shadow:0px 1px 2px #CCC,inset 0 1px 0 #FFFFFF
  7. }
  8. /* Recommended */
  9. .selector,
  10. .selector-secondary,
  11. .selector[type="text"] {
  12. padding: 15px;
  13. margin-bottom: 15px;
  14. background-color: rgba(0,0,0,.5);
  15. box-shadow: 0 1px 2px #ccc, inset 0 1px 0 #fff;
  16. }

声明顺序

相关属性应为一组,推荐的样式编写顺序

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

由于定位(positioning)可以从正常的文档流中移除元素,并且还能覆盖盒模型(box model)相关的样式,因此排在首位。盒模型决定了组件的尺寸和位置,因此排在第二位。

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

  1. .declaration-order {
  2. /* Positioning */
  3. position: absolute;
  4. top: 0;
  5. right: 0;
  6. bottom: 0;
  7. left: 0;
  8. z-index: 100;
  9. /* Box model */
  10. display: block;
  11. box-sizing: border-box;
  12. width: 100px;
  13. height: 100px;
  14. padding: 10px;
  15. border: 1px solid #e5e5e5;
  16. border-radius: 3px;
  17. margin: 10px;
  18. float: right;
  19. overflow: hidden;
  20. /* Typographic */
  21. font: normal 13px "Helvetica Neue", sans-serif;
  22. line-height: 1.5;
  23. text-align: center;
  24. /* Visual */
  25. background-color: #f5f5f5;
  26. color: #fff;
  27. opacity: .8;
  28. /* Other */
  29. cursor: pointer;
  30. }

引号使用

url() 、属性选择符、属性值使用双引号。参考 Is quoting the value of url() really necessary?

  1. /* Not recommended */
  2. @import url(//www.google.com/css/maia.css);
  3. html {
  4. font-family: 'open sans', arial, sans-serif;
  5. }
  6. /* Recommended */
  7. @import url("//www.google.com/css/maia.css");
  8. html {
  9. font-family: "open sans", arial, sans-serif;
  10. }
  11. .selector[type="text"] {
  12. }

媒体查询(Media query)的位置

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

  1. .element { ... }
  2. .element-avatar { ... }
  3. .element-selected { ... }
  4. @media (max-width: 768px) {
  5. .element { ...}
  6. .element-avatar { ... }
  7. .element-selected { ... }
  8. }

不要使用 @import

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

替代办法:

  • 使用多个 元素;
  • 通过 Sass 或 Less 类似的 CSS 预处理器将多个 CSS 文件编译为一个文件;
  • 其他 CSS 文件合并工具;

参考 don’t use @import

链接的样式顺序:

a:link -> a:visited -> a:hover -> a:active(LoVeHAte)

无需添加浏览器厂商前缀

使用 Autoprefixer 自动添加浏览器厂商前缀,编写 CSS 时不需要添加浏览器前缀,直接使用标准的 CSS 编写。

Autoprefixer 通过 Can I use,按兼容的要求,对相应的 CSS 代码添加浏览器厂商前缀。