首页 > 网页制作 > CSS

html5+CSS3的编码规范

admin CSS 2022-02-05 15:31:44 html5   CSS3   编码规范"

黄金定律

不管有多少人共同参与同一项目,一定要确保每一行代码都像是同一个人编写的。

语法

1.用两个空格来代替制表符(tab) – 这是唯一能保证在所有环境下获得一致展现的方法。
2.嵌套元素应当缩进一次(即两个空格)。
3.对于属性的定义,确保全部使用双引号,绝不要使用单引号。
4.不要在自闭合(self-closing)元素的尾部添加斜线 – HTML5 规范中明确说明这是可选的。
5.不要省略可选的结束标签(closing tag)



  
    Page title
  
  
    Company
    

Hello, world!

HTML5 doctype

为每个 HTML 页面的第一行添加标准模式(standard mode)的声明,这样能够确保在每个浏览器中拥有一致的展现。



  
  

语言属性

根据 HTML5 规范:
强烈建议为 html 根元素指定 lang 属性,从而为文档设置正确的语言。这将有助于语音合成工具确定其所应该采用的发音,有助于翻译工具确定其翻译时所应遵守的规则等等。


  

IE 兼容模式

IE 支持通过特定的 标签来确定绘制当前页面所应该采用的 IE 版本。除非有强烈的特殊需求,否则最好是设置为 edge mode,从而通知 IE 采用其所支持的最新的模式。

字符编码

通过明确声明字符编码,能够确保浏览器快速并容易的判断页面内容的渲染方式。这样做的好处是,可以避免在 HTML 中使用字符实体标记(character entity),从而全部与文档编码一致(一般采用 UTF-8 编码)。


  

引入 CSS 和 JavaScript 文件

根据 HTML5 规范,在引入 CSS 和 JavaScript 文件时一般不需要指定 type 属性,因为 text/css 和 text/javascript 分别是它们的默认值。








实用为王

尽量遵循 HTML 标准和语义,但是不要以牺牲实用性为代价。任何时候都要尽量使用最少的标签并保持最小的复杂度。

属性顺序

HTML 属性应当按照以下给出的顺序依次排列,确保代码的易读性。

class
id, name
*
src, for, type, href, value
title, alt
role, aria-*

class 用于标识高度可复用组件,因此应该排在首位。id 用于标识具体组件,应当谨慎使用(例如,页面内的书签),因此排在第二位。

布尔(boolean)型属性

布尔型属性可以在声明时不赋值。XHTML 规范要求为其赋值,但是 HTML5 规范不需要。
更多信息请参考 WhatWG section on boolean attributes:
元素的布尔型属性如果有值,就是 true,如果没有值,就是 false。
如果一定要为其赋值的话,请参考 WhatWG 规范:
如果属性存在,其值必须是空字符串或 […] 属性的规范名称,并且不要在首尾添加空白符。
简单来说,就是不用赋值。

减少标签的数量

编写 HTML 代码时,尽量避免多余的父元素。很多时候,这需要迭代和重构来实现。请看下面的案例:



  



JavaScript%20生成的标签

通过%20JavaScript%20生成的标签让内容变得不易查找、编辑,并且降低性能。能避免时尽量避免。

CSS语法

1.用两个空格来代替制表符(tab)%20–%20这是唯一能保证在所有环境下获得一致展现的方法。 2.为选择器分组时,将单独的选择器单独放在一行。 3.为了代码的易读性,在每个声明块的左花括号前添加一个空格。 4.声明块的右花括号应当单独成行。 5.每条声明语句的%20:%20后应该插入一个空格。 6.为了获得更准确的错误报告,每条声明都应该独占一行。 7.所有声明语句都应当以分号结尾。最后一条声明语句后面的分号是可选的,但是,如果省略这个分号,你的代码可能更易出错。 8.对于以逗号分隔的属性值,每个逗号后面都应该插入一个空格(例如,box-shadow)。 9.不要在%20rgb()、rgba()、hsl()、hsla()%20或%20rect()%20值的内部的逗号后面插入空格。这样利于从多个属性值(既加逗号也加空格)中区分多个颜色值(只加逗号,不加空格)。 10.对于属性值或颜色参数,省略小于%201%20的小数前面的%200%20(例如,.5%20代替%200.5;-.5px%20代替%20-0.5px)。 11/十六进制值应该全部小写,例如,#fff。在扫描文档时,小写字符易于分辨,因为他们的形式更易于区分。 12.尽量使用简写形式的十六进制值,例如,用%20#fff%20代替%20#ffffff。 13.为选择器中的属性添加双引号,例如,input[type=”text”]。只有在某些情况下是可选的,但是,为了代码的一致性,建议都加上双引号。 14.避免为%200%20值指定单位,例如,用%20margin:%200;%20代替%20margin:%200px;。

/*%20Bad%20CSS%20*/ .selector,%20.selector-secondary,%20.selector[type=text]%20{ %20%20padding:15px; %20%20margin:0px%200px%2015px; %20%20background-color:rgba(0,%200,%200,%200.5); %20%20box-shadow:0px%201px%202px%20#CCC,inset%200%201px%200%20#FFFFFF } /*%20Good%20CSS%20*/ .selector, .selector-secondary, .selector[type="text"]%20{ %20%20padding:%2015px; %20%20margin-bottom:%2015px; %20%20background-color:%20rgba(0,0,0,.5); %20%20box-shadow:%200%201px%202px%20#ccc,%20inset%200%201px%200%20#fff; }

声明顺序

相关的属性声明应当归为一组,并按照下面的顺序排列:

Positioning Box%20model Typographic Visual

由于定位(positioning)可以从正常的文档流中移除元素,并且还能覆盖盒模型(box%20model)相关的样式,因此排在首位。盒模型排在第二位,因为它决定了组件的尺寸和位置。 其他属性只是影响组件的内部(inside)或者是不影响前两组属性,因此排在后面。

.declaration-order%20{ %20%20/*%20Positioning%20*/ %20%20position:%20absolute; %20%20top:%200; %20%20right:%200; %20%20bottom:%200; %20%20left:%200; %20%20z-index:%20100; %20%20/*%20Box-model%20*/ %20%20display:%20block; %20%20float:%20right; %20%20width:%20100px; %20%20height:%20100px; %20%20/*%20Typography%20*/ %20%20font:%20normal%2013px%20"Helvetica%20Neue",%20sans-serif; %20%20line-height:%201.5; %20%20color:%20#333; %20%20text-align:%20center; %20%20/*%20Visual%20*/ %20%20background-color:%20#f5f5f5; %20%20border:%201px%20solid%20#e5e5e5; %20%20border-radius:%203px; %20%20/*%20Misc%20*/ %20%20opacity:%201; }

不要使用%20@import

与%20标签相比,@import%20指令要慢很多,不光增加了额外的请求次数,还会导致不可预料的问题。替代办法有以下几种:

使用多个%20元素

通过%20Sass%20或%20Less%20类似的%20CSS%20预处理器将多个%20CSS%20文件编译为一个文件 通过%20Rails、Jekyll%20或其他系统中提供过%20CSS%20文件合并功能

媒体查询(Media%20query)的位置

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

.element%20{%20https://www.iwyv.com/d/files/20220205/ouqxa1030bm%20} .element-avatar%20{%20https://www.iwyv.com/d/files/20220205/ouqxa1030bm%20} .element-selected%20{%20https://www.iwyv.com/d/files/20220205/ouqxa1030bm%20} @media%20(min-width:%20480px)%20{ %20%20.element%20{%20https://www.iwyv.com/d/files/20220205/ouqxa1030bm} %20%20.element-avatar%20{%20https://www.iwyv.com/d/files/20220205/ouqxa1030bm%20} %20%20.element-selected%20{%20https://www.iwyv.com/d/files/20220205/ouqxa1030bm%20} }

单行规则声明

对于只包含一条声明的样式,为了易读性和便于快速编辑,建议将语句放在同一行。对于带有多条声明的样式,还是应当将声明分为多行。

这样做的关键因素是为了错误检测%20–%20例如,CSS%20校验器指出在%20183%20行有语法错误。如果是单行单条声明,你就不会忽略这个错误;如果是单行多条声明的话,你就要仔细分析避免漏掉错误了。

/*%20Single%20declarations%20on%20one%20line%20*/ .span1%20{%20width:%2060px;%20} .span2%20{%20width:%20140px;%20} .span3%20{%20width:%20220px;%20} /*%20Multiple%20declarations,%20one%20per%20line%20*/ .sprite%20{ %20%20display:%20inline-block; %20%20width:%2016px; %20%20height:%2015px; %20%20background-image:%20url(../img/sprite.png); } .icon { background-position: 0 0; } .icon-home { background-position: 0 -20px; } .icon-account { background-position: 0 -40px; }

简写形式的属性声明

在需要显示地设置所有值的情况下,应当尽量限制使用简写形式的属性声明。常见的滥用简写属性声明的情况如下:

padding
margin
font
background
border
border-radius

大部分情况下,我们不需要为简写形式的属性声明指定所有值。例如,HTML 的 heading 元素只需要设置上、下边距(margin)的值,因此,在必要的时候,只需覆盖这两个值就可以。过度使用简写形式的属性声明会导致代码混乱,并且会对属性值带来不必要的覆盖从而引起意外的副作用。

/* Bad example */
.element {
  margin: 0 0 10px;
  background: red;
  background: url("image.jpg");
  border-radius: 3px 3px 0 0;
}

/* Good example */
.element {
  margin-bottom: 10px;
  background-color: red;
  background-image: url("image.jpg");
  border-top-left-radius: 3px;
  border-top-right-radius: 3px;
}

Less 和 Sass 中的嵌套

避免不必要的嵌套。这是因为虽然你可以使用嵌套,但是并不意味着应该使用嵌套。只有在必须将样式限制在父元素内(也就是后代选择器),并且存在多个需要嵌套的元素时才使用嵌套。

// Without nesting
.table > thead > tr > th { … }
.table > thead > tr > td { … }

// With nesting
.table > thead > tr {
  > th { … }
  > td { … }
}

Less 和 Sass 中的操作符

为了提高可读性,在圆括号中的数学计算表达式的数值、变量和操作符之间均添加一个空格。

// Bad example
.element {
  margin: 10px 0 @variable*2 10px;
}

// Good example
.element {
  margin: 10px 0 (@variable * 2) 10px;
}

注释

代码是由人编写并维护的。请确保你的代码能够自描述、注释良好并且易于他人理解。好的代码注释能够传达上下文关系和代码目的。不要简单地重申组件或 class 名称。

对于较长的注释,务必书写完整的句子;对于一般性注解,可以书写简洁的短语。

/* Bad example */
/* Modal header */
.modal-header {
  https://www.iwyv.com/d/files/20220205/ouqxa1030bm
}

/* Good example */
/* Wrapping element for .modal-title and .modal-close */
.modal-header {
  https://www.iwyv.com/d/files/20220205/ouqxa1030bm
}

class 命名

1.class 名称中只能出现小写字符和破折号(dashe)(不是下划线,也不是驼峰命名法)。破折号应当用于相关 class 的命名(类似于命名空间)(例如,.btn 和 .btn-danger)。
2.避免过度任意的简写。.btn 代表 button,但是 .s 不能表达任何意思。
3.class 名称应当尽可能短,并且意义明确。
4.使用有意义的名称。使用有组织的或目的明确的名称,不要使用表现形式(presentational)的名称。
5.基于最近的父 class 或基本(base) class 作为新 class 的前缀。
6.使用 .js-* class 来标识行为(与样式相对),并且不要将这些 class 包含到 CSS 文件中。

/* Bad example */
.t { https://www.iwyv.com/d/files/20220205/ouqxa1030bm }
.red { https://www.iwyv.com/d/files/20220205/ouqxa1030bm }
.header { https://www.iwyv.com/d/files/20220205/ouqxa1030bm }

/* Good example */
.tweet { https://www.iwyv.com/d/files/20220205/ouqxa1030bm }
.important { https://www.iwyv.com/d/files/20220205/ouqxa1030bm }
.tweet-header { https://www.iwyv.com/d/files/20220205/ouqxa1030bm }

选择器

对于通用元素使用 class ,这样利于渲染性能的优化。
对于经常出现的组件,避免使用属性选择器(例如,[class^=”…”])。浏览器的性能会受到这些因素的影响。
选择器要尽可能短,并且尽量限制组成选择器的元素个数,建议不要超过 3 。
只有在必要的时候才将 class 限制在最近的父元素内(也就是后代选择器)(例如,不使用带前缀的 class 时 – 前缀类似于命名空间)。

/* Bad example */
span { https://www.iwyv.com/d/files/20220205/ouqxa1030bm }
.page-container #stream .stream-item .tweet .tweet-header .username { https://www.iwyv.com/d/files/20220205/ouqxa1030bm }
.avatar { https://www.iwyv.com/d/files/20220205/ouqxa1030bm }

/* Good example */
.avatar { https://www.iwyv.com/d/files/20220205/ouqxa1030bm }
.tweet-header .username { https://www.iwyv.com/d/files/20220205/ouqxa1030bm }
.tweet .avatar { https://www.iwyv.com/d/files/20220205/ouqxa1030bm }

编辑器配置

将你的编辑器按照下面的配置进行设置,以避免常见的代码不一致和差异:

  • 用两个空格代替制表符(soft-tab 即用空格代表 tab 符)。
  • 保存文件时,删除尾部的空白符。
  • 设置文件编码为 UTF-8。
  • 在文件结尾添加一个空白行。

参照文档并将这些配置信息添加到项目的 .editorconfig 文件中。例如:Bootstrap 中的 .editorconfig 实例。更多信息请参考 about EditorConfig

更好更舒服的阅读,请查看这篇文章https://www.iwyv.com/d/files/20220205/c4uaumvcujv

版权声明

本文仅代表作者观点,不代表本站立场。
本文系作者授权发表,未经许可,不得转载。
本文地址:/web/CSS/73216.html

留言与评论(共有 0 条评论)
   
验证码:

潘少俊衡

| 桂ICP备2023010378号-4

Powered By EmpireCMS

爱享小站

中德益农

谷姐神农

环亚肥料

使用手机软件扫描微信二维码

关注我们可获取更多热点资讯

感谢潘少俊衡友情技术支持