重点:
1、不管多少人一块写代码,一定要确保每一行代码都像是同一个人写的,风格不一的话尽量去适应。
2、最好用两个空格来代替制表符(tab),这是唯一能保证在所有环境下获得一致展现的方法。
3、注释
代码是由人编写并维护的。请确保你的代码能够自描述、注释良好并且易于他人理解。好的代码注释能够传达上下文关系和代码目的。不要简单地重申组件或 class 名称。
对于较长的注释,务必书写完整的句子;对于一般性注解,可以书写简洁的短语。
一、命名规范:
1、基本要求:
(1)文件编码统一使用 UTF-8 编码;
(2)命名时以符合语义为主要参考指标,CSS属性书写规范,采用统一风格及命名方法;
(3)结构清晰,层级关系明朗,以不超过三级为标准;
(4)同一表现形式的样式要求可重复利用,模块组件类的样式要求可整体外部移植;
(5)编写 CSS 的时候,应当避免使用CSS Hack,能不用则不用。
(6)所有页面默认都针对Firefox 等最接近标准的浏览器进行设计,然后使用 IE 特有条件注释功能进行针对性修正。
(7)请使用英文进行命名,尽量避免使用拼音。命名要求具有可读性,尽量避免使用缩写。命名虽然允许数字,但应尽量避免使用数字命名。
2、命名方法 要求采用统一的命名方法。常用命名方法有:
(1)连写式命名法,如:helloworld
(2)中线命名法,如:hello-world(目前采用此方法的较多,建议采用)
(3)下划线命名法,如:hello_world
(4)骆驼命名法,如:helloWorld
(5)帕斯卡命名法,如:HelloWorld
(6)其他方法。
3、样式文件命名规范 如:
全局的:global.css;
主要的:master.css;
布局、版面:layout.css;
专栏:columns.css;
文字:font.css;
打印样式:print.css;
主题:themes.css;
补丁:pacth.css;
格式化浏览器:base.css等。
4、ID及Class命名常用名称
页头:header
登录条:login-bar
标志:logo
侧栏:side-bar
广告:banner
导航:nav
子导航:sub-nav
菜单:menu
子菜单:sub-menu
搜索:search
滚动:scroll
页面主体:main
内容:content
标签页:tab
文章列表:list
提示信息:msg
小技巧:tips
栏目标题:title
加入:joinus
指南:guild
服务:service
热点:hot
新闻:news
下载:download
注册:regsiter
状态:status
按钮:btn
投票:vote
合作伙伴:partner
友情链接:friendlink
版权:copyright
外套:wrap
页脚:footer
标题:title
顶导航:top-nav(mini-nav)
HTML 规范
1、一般规范
(1)嵌套元素应当缩进一次(即两个空格)。
(2)对于属性的定义,确保全部使用双引号,绝不要使用单引号。
(3)不要在自闭合(self-closing)元素的尾部添加斜线 -- HTML5 规范中明确说明这是可选的。
(4)不要省略可选的结束标签(closing tag)(例如,</li> 或 </body>)。
2、文档类型
推荐使用 HTML5 的文档类型申明: .
(建议使用 text/html 格式的 HTML。避免使用 XHTML。XHTML 以及它的属性,比如 application/xhtml+xml 在浏览器中的应用支持与优化空间都十分有限)
省略可选标签
HTML5 规范中规定了 HTML 标签是可以省略的。在开发的源文件中最好不要这样做,因为省略标签可能会导致一些问题。
压缩代码,缩小页面大小时,可选标签完全就可以省略掉了。
3、HTML 属性应当按照以下给出的顺序依次排列,确保代码的易读性。
(1)class
(2)id, name
(3)data-*
(4)src, for, type, href, value
(5)title, alt
(6)role, aria-*
4、语言属性
建议为 html 根元素指定 lang 属性,从而为文档设置正确的语言。这将有助于语音合成工具确定其所应该采用的发音,有助于翻译工具确定其翻译时所应遵守的规则等等。
5、标签数量
(1)编写 HTML 代码时,尽量避免多余的父元素。很多时候,这需要迭代和重构来实现。
(2)通过 JavaScript 生成的标签让内容变得不易查找、编辑,并且降低性能。能避免时尽量避免。
CSS 规范
1、命名
(1)class 名称中只能出现小写字符和破折号(dashe)(不是下划线,也不是驼峰命名法)。破折号应当用于相关 class 的命名(类似于命名空间)(例如,.btn 和 .btn-danger)。
(2)避免过度任意的简写。.btn 代表 button,但是 .s 不能表达任何意思。
(3)class 名称应当尽可能短,并且意义明确。
(4)使用有意义的名称。使用有组织的或目的明确的名称,不要使用表现形式(presentational)的名称。
(5)使用 .js-* class 来标识行为(与样式相对),并且不要将这些 class 包含到 CSS 文件中。
在为 Sass 和 Less 变量命名时也可以参考上面列出的各项规范。
(6)ID一般不应该被应用于样式。ID的样式不能被复用并且每个页面中你只能使用一次ID。多用class除非只用一次,且id选择器权重高 突然出现一个权重高的会比较奇怪
2、注意
(1)为了代码的易读性,在每个声明块的左花括号前添加一个空格。
(2)声明块的右花括号应当单独成行。
(3)每条声明语句之后应该插入一个空格。
(4)为了获得更准确的错误报告,每条声明都应该独占一行。
(5)所有声明语句都应当以分号结尾。最后一条声明语句后面的分号是可选的,但是,如果省略这个分号,代码可能更易出错。
(7)不要在 rgb()、rgba()、hsl()、hsla() 或 rect() 值的内部的逗号后面插入空格。这样利于从多个属性值(既加逗号也加空格)中区分多个颜色值(只加逗号,不加空格)。
(8)对于属性值或颜色参数,省略小于 1 的小数前面的 0 (例如,.5 代替 0.5;-.5px 代替 -0.5px)。
(9)十六进制值应该全部小写,例如,#fff。在扫描文档时,小写字符易于分辨,因为他们的形式更易于区分。
(10)尽量使用简写形式的十六进制值,例如,用 #fff 代替 #ffffff。
(11)为选择器中的属性添加双引号,例如,input[type="text"]。只有在某些情况下是可选的,但是,为了代码的一致性,建议都加上双引号。URI值(url())不要使用引号。
(12)避免为 0 值指定单位,例如,用 margin: 0; 代替 margin: 0px;。
3、相关属性一组及顺序
相关的属性声明应当归为一组,并按照下面的顺序排列:
(1)结构性属性:
display
position, left, top, right etc.
overflow, float, clear etc.
margin, padding
(2)表现性属性:
background, border etc.
font, text
原因:
(1)由于定位(positioning)可以从正常的文档流中移除元素,并且还能覆盖盒模型(box model)相关的样式,因此排在首位。
(2)盒模型排在第二位,因为它决定了组件的尺寸和位置。
(3)其他属性只是影响组件的内部(inside)或者是不影响前两组属性,因此排在后面。
.box {
display: block;
position: absolute;
left:30%; right:30%;
overflow: hidden;
margin:1em;
padding:1em;
background-color:#eee;
border:3px solid #ddd;
font-family:\'Arial\', sans-serif;
font-size:1.5rem;
text-transform: uppercase;
}
4、媒体查询(Media query)的位置
将媒体查询放在尽可能相关规则的附近。不要将他们打包放在一个单一样式文件中或者放在文档底部。如果你把他们分开了,将来只会被大家遗忘。
5、嵌套
避免不必要的嵌套。这是因为虽然你可以使用嵌套,但是并不意味着应该使用嵌套。只有在必须将样式限制在父元素内(也就是后代选择器),并且存在多个需要嵌套的元素时才使用嵌套。