• 前端代码编码规范


    一、黄金定律

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

    二、HTML

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

    1.HTML5 doctype

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

    2.语言属性

    <html lang="zh-cn">
      <!-- ... -->
    </html>
    

    3.IE 兼容模式

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

    4.字符编码

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

    5.引入 CSS 和 JavaScript 文件

    根据 HTML5 规范,在引入 CSS 和 JavaScript 文件时一般不需要指定 type 属性,因为 text/css 和 text/javascript 分别是它们的默认值。
    
    <link rel="stylesheet" href="code-guide.css">
    
    <style>
      /* ... */
    </style>
    
    <script src="code-guide.js"></script>
    

    6.实用为王

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

    7.属性顺序

    HTML 属性应当按照以下给出的顺序依次排列,确保代码的易读性。
    class
    id,name
    data-*
    src,for,type,href,value
    title,alt
    role,aria-*
    
    class 用于标识高度可复用组件,因此应该排在首位。id 用于标识具体组件,应当谨慎使用(例如,页面内的书签),因此排在第二位。
    

    8.布尔(boolean)型属性

    布尔型属性可以在声明时不赋值。XHTML 规范要求为其赋值,但是 HTML5 规范不需要。
    
    <input type="text" disabled>
    
    <input type="checkbox" value="1" checked>
    
    <select>
      <option value="1" selected>1</option>
    </select>
    

    9.减少标签的数量

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

    10.JavaScript 生成的标签

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

    三、CSS

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

    1.声明顺序

    相关的属性声明应当归为一组,并按照下面的顺序排列:
    1.Position
    2.Box model
    3.Typographic
    4.Visual
    
    .declaration-order {
      /* Positioning */
      position: absolute;
      top: 0;
      right: 0;
      bottom: 0;
      left: 0;
      z-index: 100;
    
      /* Box-model */
      display: block;
      float: right;
       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;
    }
    

    2.不要使用 @import

    与 <link> 标签相比,@import 指令要慢很多,不光增加了额外的请求次数,还会导致不可预料的问题。替代办法有以下几种:
    1)使用多个 <link> 元素
    2)通过 Sass 或 Less 类似的 CSS 预处理器将多个 CSS 文件编译为一个文件
    3)通过 Rails、Jekyll 或其他系统中提供过 CSS 文件合并功能
    

    3.媒体查询(Media query)的位置

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

    4.带前缀的属性

    当使用特定厂商的带有前缀的属性时,通过缩进的方式,让每个属性的值在垂直方向对齐,这样便于多行编辑。
    
    .selector {
      -webkit-box-shadow: 0 1px 2px rgba(0,0,0,.15);
              box-shadow: 0 1px 2px rgba(0,0,0,.15);
    }
    

    5.单行规则声明

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

    6.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 文件中。
    

    7.选择器

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

    8.编辑器配置

    1)用两个空格代替制表符(soft-tab 即用空格代表 tab 符)。
    2)保存文件时,删除尾部的空白符。
    3)设置文件编码为 UTF-8。
    4)在文件结尾添加一个空白行。
  • 相关阅读:
    「CH2401」送礼物 解题报告
    IO流总结
    关于Servlet中GET和POST方法的总结
    关于Java-枚举的总结
    JVM原理
    Form表单中method="post/get'的区别
    基于Servlet+JSP+JavaBean开发模式的用户登录注册
    浅谈jsp和servlet的区别
    serialVersionUID作用
    oracle的oci和thin区别
  • 原文地址:https://www.cnblogs.com/moonlightL/p/7419641.html
Copyright © 2020-2023  润新知