前端开发规范

说明

字体颜色

  • 红色 标识为 重点
  • 绿色 标识为 技巧
  • 蓝色 标识为 提示
  • 黄色 标识为 警告

通用要求

目的

  1. 代码一致性
    通过保持代码风格和传统的一致性,我们可以减少遗留系统维护的负担,并降低未来系统崩溃的风险。
  2. 最佳实践
    通过遵照最佳实践,我们能确保优化的页面加载、性能以及可维护的代码。

核心

  1. 表现、内容和行为的分离
  2. 标记应该是结构良好、语义正确 以及 普遍合法
  3. Javascript应该起到渐进式增强用户体验的作用

基本原则

  1. 缩进
    统一四个空格缩进(总之缩进统一即可),不要使用 Tab或者Tab、空格混搭。建议设置开发工具一个Tab为四个空格。
  2. 文件编码
    使用不带 BOM 的 UTF-8 编码。
    • 在 HTML中指定编码
    • 使用scss编写css文件头部需设置@charset “utf-8”;,否则添加中文注释报错。一般css文件不用设置。
  3. 一律使用小写字母

  4. 统一注释
    通过配置编辑器,可以提供快捷键来输出一致认可的注释模式。

    • HTML 注释
      1.模块注释

      1
      2
      3
      4

      <div class="article-list">
      ...
      div>

      2.区块注释

      1
      2
      3
      4
      5

    • CSS 注释
      组件块和子组件块以及声明块之间使用一空行分隔,子组件块之间三空行分隔。

      1
      2
      3
      4
      5
      6
      7
      8
      9
      10
      11
       
      /* ==========================================================================
      组件块
      ========================================================================= */

      /* 子组件块
      ============================================================================ */

      .selector-secondary {
      display: block; /* 注释*/
      }
    • Javascript注释
      1.单行注释
      必须独占一行。// 后跟一个空格,缩进与下一行被注释说明的代码一致。
      2.多行注释
      避免使用 /*…*/ 这样的多行注释。有多行注释内容时,使用多个单行注释。
      3.函数/方法要注释

      • 注释包括函数说明,有参数和返回值时必须使用注释标识。参数和返回值注释必须包含类型信息和说明。
      • 当函数是内部函数,外部不可访问时,可以使用 @inner 标识。

        Javascript
          /**
          * 函数描述
          *
          * @param {string} p1 参数1的说明
          * @param {string} p2 参数2的说明,比较长
          *     那就换行了.
          * @param {number=} p3 参数3的说明(可选)
          * @return {Object} 返回值描述
          */
          function foo(p1, p2, p3) {
          var p3 = p3 || 10;
          return {
             p1: p1,
             p2: p2,
             p3: p3
          };
          } 
        
    • 文件注释
      文件注释用于告诉不熟悉这段代码的读者这个文件中包含哪些东西。 应该提供文件的大体内容, 它的作者, 依赖关系和兼容性信息。如下:

      Javascript
        /**
         * @fileoverview Description of file, its uses and information
         * about its dependencies.
         * @author [email protected] (Firstname Lastname)
         * Copyright 2015 Meizu Inc. All Rights Reserved.
         */
      
  5. 代码验证

    • 使用 W3C HTML Validator 来验证你的HTML代码有效性和规范化。
    • 使用 W3C CSS Validator 来验证你的CSS代码有效性

HTML

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

标签

  1. 自闭合(self-closing)标签,无需闭合 ( 例如: img input br hr 等 ),img和input标签尾部需加斜杠/以免后台编译出现错误,br标签遵循标准写法
  2. 除以上标签其它标签必须闭合,包括可选闭合的标签(例如:
  3. )。
  4. 段落分隔符要使用实际对应的

    元素,而不是用多个
    标签。

  5. 列表中的条目必须总是放置于

你可能感兴趣的:(前端开发规范)