前端, 规范

前端代码规范相关整理

  1. HTML规范－整体结构
    1. HTML基础设施
    2. 结构顺序和视觉顺序基本保持一致
    3. 结构、表现、行为三者分离，避免内联
    4. 保持良好的简洁的树形结构
    5. 另外，请做到以下几点
  2. HTML规范－代码格式
    1. 代码注释方法
    2. 严格的嵌套
    3. 严格的属性
  3. HTML规范－内容语义
  4. CSS规范 - 分类方法
    1. CSS文件的分类和引用顺序
    2. CSS内部的分类及其顺序
  5. CSS规范 - 命名规则
  6. CSS规范 - 书写顺序
    1. 基本排版规范
    2. 选择器内属性的顺序和组织

更新:

最近看到一份编码规范总结的更完善,更好,贴出来作为参考
编码规范 by @mdo

主要是html、css规范，整理的目的主要是规范自己的代码，养成好的代码书写习惯。

HTML规范－整体结构

HTML基础设施

  • 文件应以“<!DOCTYPE ……>”首行顶格开始，推荐使用“<!DOCTYPE html>”。
  • 必须申明文档的编码charset，且与文件本身编码保持一致，推荐使用UTF-8编码。
  • 根据页面内容和需求填写适当的keywords和description。
  • 页面title是极为重要的不可缺少的一项。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<title>前端代码规范整理</title>
<meta name="keywords" content="前端"/>
<meta name="description" content="前端代码"/>
<meta name="viewport" content="width=device-width"/>
<link rel="stylesheet" href="css/style.css"/>
<link rel="shortcut icon" href="img/favicon.ico"/>
<link rel="apple-touch-icon" href="img/touchicon.png"/>
</head>
<body>
</body>
</html>

结构顺序和视觉顺序基本保持一致

  • 按照从上至下、从左到右的视觉顺序书写HTML结构
  • 有时候为了便于搜索引擎抓取，我们也会将重要内容在HTML结构顺序上提前。
  • 用div代替table布局，可以使HTML更具灵活性，也方便利用CSS控制。
  • table不建议用于布局，但表现具有明显表格形式的数据，table还是首选。

结构、表现、行为三者分离，避免内联

  • 使用link将css文件引入，并置于head中。
  • 使用script将js文件引入，并置于body底部。

保持良好的简洁的树形结构

  • 每一个块级元素都另起一行，每一行都使用Tab缩进对齐（head和body的子元素不需要缩进）。删除冗余的行尾的空格。
  • 使用4个空格代替1个Tab（大多数编辑器中可设置）。
  • 对于内容较为简单的表格，建议将tr写成单行。
  • 你也可以在大的模块之间用空行隔开，使模块更清晰。

另外，请做到以下几点

  • 结构上如果可以并列书写，就不要嵌套。
    如果可以写成<div></div><div></div>那么就不要写成<div><div></div></div>
  • 如果结构已经可以满足视觉和语义的要求，那么就不要有额外的冗余的结构。
    比如<div><h2></h2></div>已经能满足要求，那么就不要再写成<div><div><h2></h2></div></div>
  • 一个标签上引用的className不要过多，越少越好。
    比如不要出现这种情况：<div class="class1 class2 class3 class4"></div>
  • 对于一个语义化的内部标签，应尽量避免使用className。
    比如在这样一个列表中，li标签中的itm应去除：<ul class="m-help"><li class="itm"></li><li class="itm"></li></ul>

HTML规范－代码格式

代码注释方法

采用类似标签闭合的写法，与HTML统一格式；

  • 开始注释：<!-- 注释文案 -->（文案两头空格）
  • 结束注释：<!-- /注释文案 -->（文案前加“/”符号，类似标签的闭合）。。
  • 允许只有开始注释！
  • 单行代码的注释也保持同行，两端空格；多行代码的注释起始和结尾都另起一行并左缩进对齐。

严格的嵌套

  • 尽可能以最严格的xhtml strict标准来嵌套，比如内联元素不能包含块级元素等等。
  • 正确闭合标签且必须闭合。

严格的属性

  • 属性和值全部小写，每个属性都必须有一个值，每个值必须加双引号。
  • 没有值的属性必须使用自己的名称做为值（checked、disabled、readonly、selected等等）。
  • 可以省略style标签和script标签的type属性。

HTML规范－内容语义

  • 内容类型决定使用的语义标签：根据你的内容语义化HTML结构
  • 加强“资源型”内容的可访问性和可用性：在资源型的内容上加入描述文案，比如给img添加alt属性，在audio内加入文案和链接等等。
  • 加强“不可见”内容的可访问性：背景图上的文字应该同时写在html中，并使用css使其不可见，有利于搜索引擎抓取你的内容，也可以在css失效的情况下看到内容。
  • 适当使用实体：以实体代替与HTML语法相同的字符，避免浏览解析错误。

CSS规范 - 分类方法

CSS文件的分类和引用顺序

通常，一个项目我们只引用一个CSS，但是对于较大的项目，我们需要把CSS文件进行分类。
我们按照CSS的性质和用途，将CSS文件分成“公共型样式”、“特殊型样式”、“皮肤型样式”，并以此顺序引用（按需求决定是否添加版本号）。

CSS内部的分类及其顺序

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
/* 重置 */
div,p,ul,ol,li{margin:0;padding:0;}
/* 默认 */
strong,em{font-style:normal;font-weight:bold;}
/* 统一调用背景图 */
.m-logo a,.m-nav a,.m-nav em{background:url(images/sprite.png) no-repeat 9999px 9999px;}
/* 统一清除浮动 */
.g-bdc:after,.m-dimg ul:after,.u-tab:after{display:block;visibility:hidden;clear:both;height:0;overflow:hidden;content:'.';}
.g-bdc,.m-dimg ul,.u-tab{zoom:1;}
/* 布局 */
.g-sd{float:left;width:300px;}
/* 模块 */
.m-logo{width:200px;height:50px;}
/* 元件 */
.u-btn{height:20px;border:1px solid #333;}
/* 功能 */
.f-tac{text-align:center;}
/* 皮肤 */
.s-fc,a.s-fc:hover{color:#fff;}

CSS规范 - 命名规则

  • 提高重用性少用id；
  • 一组命名要做到能顾名思义！或者能“望文生义”；
  • 语义贴切、冲突几率、渲染性能、协作通畅；
  • 只能是 [a-z\d\-]英文字母+数字+字符“-”，用作脚本钩子的采用“J_”前缀；
  • “-“；作长命名时的“分类分隔符（如：tab-nav）”；功能上的“扩展分隔符（如：tab-trigger-active）”，

  • class命名:

    1.模块名 ；
    2.模块名-模块状态 ；
    3.模块名-子模块名 ；
    4.模块名-子模块名-模块状态 ；

  • 不能用“表象”的词命名，如：大小、颜色、方位…

  • id命名：帕斯卡命名法，CamelName

CSS规范 - 书写顺序

基本排版规范

小写、单行、多行选择器用逗号分行、每属性分号分割、单引号、缩进；

选择器内属性的顺序和组织

  • 影响文档流的属性（display, position, float, clear, visibility, table-layout）
  • 自身盒模型的属性（width, height, margin, padding, border）
  • 排版相关属性（font, line-height, text-align, text-indent, vertical-align）
  • 装饰性属性（color, background, opacity, cursor）
  • 生成内容的属性（content, list-style, quotes）
  • CSS3属性：transform/transition/animation/box-shadow/border-radius
  • 加浏览器前缀，按照 -webkit- / -moz- / -ms- / -o- / std的顺序，标准属性写在最后。

参阅：
无废话网页重构
NEC：更好的CSS样式解决方案

分享到：微信新浪微博QQ空间腾讯微博人人网