web前端编码规范

最新推荐文章于 2024-05-06 19:40:48 发布

小云云~~

最新推荐文章于 2024-05-06 19:40:48 发布

阅读量542

点赞数

分类专栏： web前端开发文章标签： web前端编码规范

本文链接：https://blog.csdn.net/sunyun0090/article/details/53406746

版权

web前端开发专栏收录该内容

10 篇文章 0 订阅

订阅专栏

web前端编码规范

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

<!DOCTYPE html>
<html>
  <head>
    <title>Page title</title>
  </head>
  <body>
    <img src="images/company-logo.png" alt="Company">
    <h1 class="hello-world">Hello, world!</h1>
  </body>
</html>

6：通过特定的 <meta> 标签来确定绘制当前页面所应该采用的 IE 版本，最好是设置为 edge mode，从而通知 IE 采用其所支持的最新的模式。
如：<meta http-equiv="X-UA-Compatible" content="IE=Edge">
7：明确声明字符编码，一般采用 UTF-8 编码。
如：<meta charset="UTF-8">
8：根据 HTML5 规范，在引入 CSS 和 JavaScript 文件时一般不需要指定 type 属性，因为 text/css 和 text/javascript 分别是它们的默认值。
如：<link rel="stylesheet" href="style.css">
<script src="common.js"></script>
9：尽量遵循 HTML 标准和语义，但是不要以牺牲实用性为代价。任何时候都要尽量使用最少的标签并保持最小的复杂度。
10：HTML 属性应当按照以下给出的顺序依次排列，确保代码的易读性。
class
id, name
data-*
src, for, type, href
title, alt
aria-*, role
class 用于标识高度可复用组件，因此应该排在首位。id 用于标识具体组件，应当谨慎使用（例如，页面内的书签），因此排在第二位。
如：

<a class="..." id="..." data-modal="toggle" href="#">
  Example link
</a>
<input class="form-control" type="text">
<img src="..." alt="...">

11：布尔型属性可以在声明时不赋值。XHTML 规范要求为其赋值，但是 HTML5 规范不需要。元素的布尔型属性如果有值，就是 true，如果没有值，就是 false。
如：

<input type="text" disabled>
<input type="checkbox" value="1" checked>
<select>
  <option value="1" selected>1</option>
</select>

12：编写 HTML 代码时，尽量避免多余的父元素。很多时候，这需要迭代和重构来实现。
如：

<span class="avatar">
  <img src="...">
</span>

<!-- 好 -->
<img class="avatar" src="...">

13：尽量避免通过 JavaScript 生成的标签，这会让内容变得不易查找、编辑，并且降低性能。

二：css
14：用两个空格来代替制表符（tab）
15：为选择器分组时，将单独的选择器单独放在一行。
16：为了代码的易读性，在每个声明块的左花括号前添加一个空格。
17：声明块的右花括号应当单独成行。
18：每条声明语句的 : 后应该插入一个空格。
19：为了获得更准确的错误报告，每条声明都应该独占一行。
20：所有声明语句都应当以分号结尾。最后一条声明语句后面的分号是可选的，但是，如果省略这个分号，你的代码可能更易出错。
21：对于以逗号分隔的属性值，每个逗号后面都应该插入一个空格（例如，box-shadow）。
22：不要在 rgb()、rgba()、hsl()、hsla() 或 rect() 值的内部的逗号后面插入空格。这样利于从多个属性值（既加逗号也加空格）中区分多个颜色值（只加逗号，不加空格）。
23：对于属性值或颜色参数，省略小于 1 的小数前面的 0 （例如，.5 代替 0.5；-.5px 代替 -0.5px）。
24：十六进制值应该全部小写，例如，#fff。在扫描文档时，小写字符易于分辨，因为他们的形式更易于区分。
25：尽量使用简写形式的十六进制值，例如，用 #fff 代替 #ffffff。
26：为选择器中的属性添加双引号，例如，input[type="text"]。只有在某些情况下是可选的，但是，为了代码的一致性，建议都加上双引号。
27：避免为 0 值指定单位，例如，用 margin: 0; 代替 margin: 0px;。
如：

/* 不好*/
.selector, .selector-secondary, .selector[type=text] {
  padding:15px;
  margin:0px 0px 15px;
  background-color:rgba(0, 0, 0, 0.5);
  box-shadow:0px 1px 2px #CCC,inset 0 1px 0 #FFFFFF
}
/* 好*/
.selector,
.selector-secondary,
.selector[type="text"] {
  padding: 15px;
  margin-bottom: 15px;
  background-color: rgba(0,0,0,.5);
  box-shadow: 0 1px 2px #ccc, inset 0 1px 0 #fff;
}

28：相关的属性声明应当归为一组，并按照下面的顺序排列：
Positioning
Box model
Typographic
Visual
由于定位（positioning）可以从正常的文档流中移除元素，并且还能覆盖盒模型（box model）相关的样式，因此排在首位。盒模型排在第二位，因为它决定了组件的尺寸和位置。
其他属性只是影响组件的内部（inside）或者是不影响前两组属性，因此排在后面。
如：

.declaration-order {
  /* Positioning */
  position: absolute;
  top: 0;
  right: 0;
  bottom: 0;
  left: 0;
  z-index: 100;


  /* Box-model */
  display: block;
  float: right;
  width: 100px;
  height: 100px;


  /* Typography */
  font: normal 13px "Helvetica Neue", sans-serif;
  line-height: 1.5;
  color: #333;
  text-align: center;


  /* Visual */
  background-color: #f5f5f5;
  border: 1px solid #e5e5e5;
  border-radius: 3px;


  /* Misc */
  opacity: 1;
}

29：不要使用 @import,与 <link> 标签相比，@import 指令要慢很多，不光增加了额外的请求次数，还会导致不可预料的问题。可以使用多个 <link> 元素，或者通过Rails、Jekyll 或其他系统合并css文件
如：<link rel="stylesheet" href="core.css">
30：将媒体查询放在尽可能相关规则的附近。不要将他们打包放在一个单一样式文件中或者放在文档底部。如果你把他们分开了，将来只会被大家遗忘。
如：

.element { ... }
.element-avatar { ... }
.element-selected { ... }


@media (min-width: 480px) {
  .element { ...}
  .element-avatar { ... }
  .element-selected { ... }
}

31：当使用特定厂商的带有前缀的属性时，通过缩进的方式，让每个属性的值在垂直方向对齐，这样便于多行编辑。
如：

.selector {
  -webkit-box-shadow: 0 1px 2px rgba(0,0,0,.15);
          box-shadow: 0 1px 2px rgba(0,0,0,.15);
}

32：对于只包含一条声明的样式，为了易读性和便于快速编辑，建议将语句放在同一行。对于带有多条声明的样式，还是应当将声明分为多行。
33：应当尽量限制使用简写形式的属性声明。常见的滥用简写属性声明的情况如下：
padding
margin
font
background
border
border-radius
大部分情况下，我们不需要为简写形式的属性声明指定所有值。例如，HTML 的 heading 元素只需要设置上、下边距（margin）的值，因此，在必要的时候，只需覆盖这两个值就可以。过度使用简写形式的属性声明会导致代码混乱，并且会对属性值带来不必要的覆盖从而引起意外的副作用。
如：

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

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

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

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

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

35：请确保你的代码能够自描述、注释良好并且易于他人理解。不要简单地重申组件或 class 名称。对于较长的注释，务必书写完整的句子；对于一般性注解，可以书写简洁的短语。
如：

/* 不好*/
/* Modal header */
.modal-header {
  ...
}

/* 好*/
/* Wrapping element for .modal-title and .modal-close */
.modal-header {
  ...
}

36：class 名称中只能出现小写字符和破折号（dashe）（不是下划线，也不是驼峰命名法）。破折号应当用于相关 class 的命名（类似于命名空间）（例如，.btn 和 .btn-danger）。
37：避免过度任意的简写。.btn 代表 button，但是 .s 不能表达任何意思。
38：class 名称应当尽可能短，并且意义明确。
39：使用有意义的名称。使用有组织的或目的明确的名称，不要使用表现形式（presentational）的名称。
40：基于最近的父 class 或基本（base） class 作为新 class 的前缀。
41：使用 .js-* class 来标识行为（与样式相对），并且不要将这些 class 包含到 CSS 文件中。
42：对于通用元素使用 class ，这样利于渲染性能的优化。
43：对于经常出现的组件，避免使用属性选择器（例如，[class^="..."]）。浏览器的性能会受到这些因素的影响。
44：选择器要尽可能短，并且尽量限制组成选择器的元素个数，建议不要超过 3 。
45：只有在必要的时候才将 class 限制在最近的父元素内（也就是后代选择器）（例如，不使用带前缀的 class 时 -- 前缀类似于命名空间）。
如：

/* 不好 */
span { ... }
.page-container #stream .stream-item .tweet .tweet-header .username { ... }
.avatar { ... }

/* 好 */
.avatar { ... }
.tweet-header .username { ... }
.tweet .avatar { ... }

三：js
46：Javascript程序应该尽量放在.js的文件中，需要调用的时候在页面中以<script src="filename.js">的形式包含进来。Javascript代码若不是该页面专用的，则应尽量避免在页面中直接编写Javascript代码。
47：js命名
命名的方法通常有以下几类：
a).命名法说明
1).camel命名法，形如thisIsAnApple
2).pascal命名法，形如ThisIsAnApple
3).下划线命名法，形如this_is_an_apple ·
4).中划线命名法，形如this-is-an-apple
根据不同类型的内容，必须严格采用如下的命名法：
b).变量名：必须使用camel命名法
c).参数名：必须使用camel命名法
d).函数名：必须使用camel命名法
e).方法/属性：必须使用camel命名法
f).私有（保护）成员：必须以下划线_开头
g).常量名：必须使用全部大写的下划线命名法，如IS_DEBUG_ENABLED
h).类名：必须使用pascal命名法
i).枚举名：必须使用pascal命名法
j).枚举的属性：必须使用全部大写的下划线命名法
k).命名空间：必须使用camel命名法
l).语义：命名同时还需要关注语义，如：
变量名应当使用名词；
boolean类型的应当使用is、has等起头，表示其类型；·
函数名应当用动宾短语；
类名应当用名词。
48：尽管 JavaScript 语言并不要求在变量使用前先对变量进行声明。但我们还是应该养成这个好习惯。这样可以比较容易的检测出那些未经声明的变量，避免其变为隐藏的全局变量，造成隐患。

四：其他

49：永远遵循同一套编码规范。
50：html页面顶端不能缺少。
如：<!DOCTYPE html>。
51：为 html 根元素指定 lang 属性，从而为文档设置正确的语言。
如：<html lang="zh-CN">
52：以组件为单位组织代码段。
53：制定一致的注释规范。
54：使用一致的空白符将代码分隔成块，这样利于扫描较大的文档。
55：如果使用了多个 CSS 文件，将其按照组件而非页面的形式分拆，因为页面会被重组，而组件只会被移动。

小云云~~

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
web前端编码规范

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

扫一扫

专栏目录