基本原则

    结构、样式、行为分离

    缩进

    统一两个空格缩进（总之缩进统一即可），不要使用 Tab 或者 Tab、空格混搭。

    文件编码

    使用不带 BOM 的 UTF-8 编码。

    • 在 HTML中指定编码 <meta charset="utf-8"> ；

    一律使用小写字母

    1. /* Recommended */
    2. color: #e5e5e5;
    4. /* Not recommended */
    5. color: #E5E5E5;

    省略外链资源 URL 协议部分

    省略外链资源（图片及其它媒体资源）URL 中的 http / https 协议，使 URL 成为相对地址，避免 Mixed Content 问题，减小文件字节数。

    1. <!-- Recommended -->
    2. <script src="//www.google.com/js/gweb/analytics/autotrack.js"></script>
    5. <script src="http://www.google.com/js/gweb/analytics/autotrack.js"></script>

    统一注释

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

    HTML 注释

    • 模块注释

      1. <div class="article-list">
      2. ...
      3. </div>

    • 区块注释

      <!--
@name: Drop Down Menu
@description: Style of top bar drop down menu.
@author: Ashu(Aaaaaashu@gmail.com)
-->
    CSS 注释
    JavaScript 注释
    • 单行注释

    必须独占一行。// 后跟一个空格，缩进与下一行被注释说明的代码一致。

    • 多行注释

    避免使用 /*...*/ 这样的多行注释。有多行注释内容时，使用多个单行注释。

    • 函数/方法注释
    1. 函数/方法注释必须包含函数说明，有参数和返回值时必须使用注释标识。；
    2. 参数和返回值注释必须包含类型信息和说明；
    3. 当函数是内部函数，外部不可访问时，可以使用 @inner 标识；
    

      

    • 文件注释
    

    文件注释用于告诉不熟悉这段代码的读者这个文件中包含哪些东西。 应该提供文件的大体内容, 它的作者, 依赖关系和兼容性信息。如下:
    

    /**
 * @fileoverview Description of file, its uses and information
 * about its dependencies.
 * @author user@meizu.com (Firstname Lastname)
 * Copyright 2015 Meizu Inc. All Rights Reserved.
 */

    

    代码验证