编写统一、符合习惯的CSS的原则
为什么80%的码农都做不了架构师?>>>
1. 通用原则
“作为成功的项目的一员,很重要的一点是意识到只为自己写代码是很糟糕的行为。如果将有成千上万人使用你的代码, 那么你需要编写最具明确性的代码,而不是以自我的喜好来彰显自己的智商。” - Idan Gazit
- 在任何代码库中,无论有多少人参与及贡献,所有代码都应该如同一个人编写的一样。
- 严格执行一致认可的风格。
- 如果有疑义,则使用现有的、通用的模式。
2. 空格
在项目的所有代码中,应该只有一个风格。在空格的使用上,必须始终保持一致。使用空格来提高可读性。
- *永远不要*在缩进时混用空格和TAB。
- 在软缩进(使用空格)和真正的TAB间选择其一。并始终坚持这一选择。(推荐使用空格)
- 如果使用空格进行缩进,选择每个缩进所使用的空格数。(推荐:4个空格)
提示:将编辑器配置为“显示不可见内容”。这使你可以清除行尾的空格和不需要缩进的空行里的空格,同时可以避免对注释的污染。
3. 注释
良好的注释是非常重要的。请留出时间来描述组件(component)的工作方式、局限性和构建它们的方法。不要让你的团队其它成员 来猜测一段不通用或不明显的代码的目的。
注释的风格应当简洁,并在代码库中保持统一。
- 将注释放在主题上方并独占一行。
- 避免在行未放置注释。
- 控制每行长度在合理的范围内,比如80个字符。
- 使用注释从字面上将CSS代码分隔为独立的部分。
- 注释的大小写应当与普通句子相同,并且使用一致的文本缩进。
提示:通过配置编辑器,可以提供快捷键来输出一致认可的注释模式。
CSS示例:
/* ================================================================区块注释段============================================================== *//* 子区块注释段============================================================= *//** 分组注释段* 用于多行的释义或文档。*//* 基本注释 */
SCSS示例:
// ==============================================================
// 区块注释段
// ==============================================================// 子区块注释段
// ==============================================================//
// 分组注释段
// 用于多行的释义或文档。
//// 基本注释
4. 格式
最终选择的代码风格必须保证:易于阅读,易于清晰地注释,最小化无意中引入错误的可能性,可生成有用的diff和blame。
- 在多个选择器的规则集中,每个单独的选择器独占一行。
- 在规则集的左大括号前保留一个空格。
- 在声明块中,每个声明独占一行。
- 每个声明前保留一级缩进。
- 每个声明的冒号后保留一个空格。
- 对于声明块的最后一个声明,始终保留结束的分号。
- 规则集的右大括号保持与该规则集的第一个字符在同一列。
- 每个规则集之间保留一个空行。
.selector-1,
.selector-2,
.selector-3 {-webkit-box-sizing: border-box;-moz-box-sizing: border-box;box-sizing: border-box;display: block;color: #333;background: #fff;
}
声明顺序
样式声明的顺序应当遵守一个单一的原则。我的倾向是将相关的属性组合在一起,并且将对结构来说比较重要的属性(如定位或者盒模型) 放在前面,先于排版、背景及颜色等属性。
.selector {position: relative;display: block;width: 50%;height: 100px;padding: 10px;border: 0;margin: 10px;color: #fffbackground: #000;
}
按字母排序也非常流行,但是这种做法存在一个缺点,即会将相关的属性分开。例如定位偏移量会无法放在一起,盒模型相关的属性会四散分布在一个声明块中。
例外及细微偏移原则的情况
对于大量仅包含单条声明的声明块,可以使用一种略微不同的单行格式。在这种情况下,在左大括号之后及右大括号之前都应该保留一个空格。
.selector-1 { width: 10%; }
.selector-2 { width: 20%; }
.selector-3 { width: 30%; }
对于以逗号分隔并且非常长的属性值 -- 例如一堆渐变或者阴影的声明 -- 可以放在多行中,这有助于提高可读性,并易于生成有效的diff。这种情况下有多 种格式可以选择,以下展示了一种格式。
.selector {box-shadow:1px 1px 1px #000,2px 2px 1px 1px #ccc inset;background-image:linear-gradient(#fff, #ccc),linear-gradient(#f3c, #4ec);
}
杂项
- 在十六进制值中,使用小写,如
#aaa
。 - 单引号或双引号的选择保持一致。推荐使用双引号,如
content: ""
。 - 对于选择器中的属性值也加上引号,如
input[type="checkout"]
。 - *如果可以的话*,不要给0加上单位, 如
margin: 0
。
预处理:格式方面额外的考虑
不同的CSS预处理有着不同的特性、功能以及语法。编码习惯应当根据使用的预处理程序进行扩展,以适应其特有的功能。推荐在使用SCSS时遵守以下指导。
- 将嵌套深度限制在1级。对于超过2级的嵌套,给予重新评估。这可以避免出现过于详实的CSS选择器。
- 避免大量的嵌套规则。当可读性受到影响时,将之打断。推荐避免出现多于20行的嵌套规则出现。
- 始终将
@extend
语句放在声明块的第一行。 - 如果可以的话,将
@include
语句放在声明块的顶部,紧接着@extend
语句的位置。 - 考虑在自定义函数的名字前加上
x-
或其它形式的前缀。这有助于避免将自己的函数和CSS的原生函数混淆,或函数命名与库函数冲突。
.selector-1 {@extend .other-rule;@include clearfix();@include box-sizing(border-box);width: x-grid-unit(1);// other declarations
}
5. 命名
不要试着把自己当作编译器或者预处理器,因此命名的时候尽量采用清晰的、有意义的名字。另外,对于 html文件和css文件中的代码,尽量采用一致的命名规则。
/* 没有意义的命名 */
.s-scr {overflow: auto;
}
.cb {background: #000;
}/* 比较有意义的命名方式 */
.is-scrollable {overflow: auto;
}
.column-body {background: #000;
}
6. 实例
下面是含有上述约定的示例代码:
/* ==========================================================================Grid layout========================================================================== *//** HTML代码示例:** <div class="grid">* <div class="cell cell-5"></div>* <div class="cell cell-5"></div>* </div>*/.grid {overflow: visible;height: 100%;/* Prevent inline-block cells wrapping */white-space: nowrap;/* Remove inter-cell whitespace */font-size: 0;
}.cell {box-sizing: border-box;position: relative;overflow: hidden;width: 20%;height: 100%;/* Set the inter-cell spacing */padding: 0 10px;border: 2px solid #333;vertical-align: top;/* Reset white-space */white-space: normal;/* Reset font-size */font-size: 16px;
}/* Cell states */.cell.is-animating {background-color: #fffdec;
}/* Cell dimensions========================================================================== */.cell-1 { width: 10%; }
.cell-2 { width: 20%; }
.cell-3 { width: 30%; }
.cell-4 { width: 40%; }
.cell-5 { width: 50%; }/* Cell modifiers========================================================================== */.cell--detail,
.cell--important {border-width: 4px;
}
7. 代码组织
对于css代码库来说,如何组织代码文件是很重要的,尤其对于那些很大的代码库显得更加重要。这里介绍 几个组织代码的建议:
- 逻辑上对不同的代码进行分离。
- 不同的组件(component)的css尽量用不同的css文件(可以在build阶段用工具合并到一起)
- 如果用到了预处理器(比如less),把一些公共的样式代码抽象成变量,例如颜色,字体等等。
8. 构建及部署
任何一个项目,都应该有一个build的过程,在这个阶段我们可以通过工具对代码进行检测,测试,压缩等等,还 可以为生产环境准备好带有版本号的代码。在这里我推荐一下grunt这个工具,我感觉它很不错。
转载于:https://my.oschina.net/hchen/blog/63032
编写统一、符合习惯的CSS的原则相关推荐
- 高效整洁CSS代码原则
CSS学起来并不难,但在大型项目中,就变得难以管理,特别是不同的人在CSS书写风格上稍有不同,团队上就更加难以沟通,为此总结了一些如何实现高效整洁的CSS代码原则: 1. 使用Reset但并非全局Re ...
- 《编码规范和测试方法——C/C++版》作业 ·008——编写一个符合依赖倒置原则的简单学生管理系统
文章目录 问题描述 参考解答 整体架构 UML图 整体代码 MySQL-C-API封装 Model层 Dao层 Service层 Controller层 View层 主程序 测试环境 测试流程 测试效 ...
- css就近原则_细品100道CSS知识点(上)「干货满满」
作者:hh_phoebe 转发链接:https://juejin.im/post/5ee0cf335188254ec9505381 目录 细品100道CSS知识点(上)[干货满满]本篇 细品100道C ...
- 用vue优雅地编写UI组件的几条指导原则
前言 最近在尝试写几个UI组件,并通过阅读element-ui的源码,与其反复比较,然后认真思考,最后总结出一些自己的一些心得和体会.在造轮子的过程中,既巩固了html,css,js基础,又加深了对v ...
- css就近原则_CSS常用总结 - div-import-border - ItBoth
[HTML CSS + DIV实现整体布局1.技术目标:开发符合W3C标准的Web页面理解盒子模型实现DIV+CSS整体布局2.什么是W3C标准? W3C:World Wide Web Cons ...
- css就近原则_CSS 三大特性
CSS 三大特性 CSS的三个特性是指层叠性.继承性以及优先级. 一.CSS层叠性 说明 层叠性是多种CSS样式的叠加,是浏览器处理样式冲突的方式.在HTML中对于同一个元素可以有多个CSS样式存在, ...
- css就近原则_CSS的引入方式和优先级
1.CSS的引入方式 CSS一共有四种引入方式,内联样式.内部样式表.外部样式表和@import引入. 1.1 内联样式 使用style属性引入样式. 123 缺点:HTML页面不纯净,文件体积大,不 ...
- UML ~ Unified Modeling Language ~ 统一建模语言。+ 软件设计原则。
UML ~ Unified Modeling Language ~ 统一建模语言. 文章目录 UML ~ Unified Modeling Language ~ 统一建模语言. what. 类图. 类 ...
- css就近原则_「Web前端开发进阶篇」CSS优先级
所谓CSS优先级,即是指CSS样式在浏览器中被解析的先后顺序.既然样式有优先级,那么就会有一个规则来约定这个优先级,而这个"规则"就是重点. [引言] 讲解完这篇CSS优先级的文章 ...
最新文章
- C语言学习笔记--动态库和静态库的使用
- 太骚了!Python模型完美切换SAS,还能这么玩。。
- HDU Problem - 6383 p1m2(二分)
- thymeleaf 模板语言简介
- 实例化Java对象_Java面向对象基础之对象实例化
- 大数据里的婚姻:婚后两年,出轨高峰……
- RabbitMq(十二) 借用死信交换机实现延迟队列
- php 立即执行函数,关于javascrip的立即执行函数的解析
- 在阿里云上遇见更好的Oracle(四)
- 实际打印页码偏上_4个Excel打印小技巧,想怎么打就怎么打?
- 百度前端技术学院---vue动态数据绑定-3
- linux快速安装mysql教程
- fh 幅频特性曲线怎么画fl_测量rc带通滤波器的幅频特性和相频特性-电子科技大学.ppt...
- matlab tic和toc单位,matlab toc tic 的用法
- Linux系统之audit
- 2021基于Debian的All in One(NAS+软路由)配置教程
- 串口工具Kermit
- 石油基琥珀酸的全球与中国市场2022-2028年:技术、参与者、趋势、市场规模及占有率研究报告
- 数据分析之Matplotlib(二)折线图(plot)
- Android---简易Snackbar
热门文章
- Excel VBA(宏):添加宏
- C++多线程并发中线程管理
- QT5.10.0安装教程图文教程以及安装成功QT5.10.0后环境配置图文步骤
- swift5的代理的使用
- 控件 qml_Flat风格的Qml进度条
- python数字信号处理应用中文pdf_人邮新书 Python数字信号处理应用 Python在DSP中应用教程 Python基础 Pytho...
- python format函数实例_python中强大的format函数实例详解
- mime java_MIME - Wei_java - 博客园
- 企业中书写css,web前端开发企业级CSS常用命名,书写规范总结(示例代码)
- mysql限制类别_MySQL限制每个类别的结果