前端编码规范

编码规范

1. 项目代码格式规范

   1.1 使用editorconfig  VS里安装editorConfig for VS Code

   charset = utf-8
   indent_style = space
   indent_size = 2
   end_of_line = lf
   insert_final_newline = true
   trim_trailing_whitespace = true
   复制代码

   1.2 JS 语法规范模块

   安装vscode eslint插件   Airbnb JavaScript 代码规范

   1.3 CSS语法规范 less语法学习

   ***安装Beautify这款VScode插件，F1而后Beautify***
   
    目录组织按照components，pages，variable，common.less组织
   复制代码

   1.4 注释规范

   使用 // FIXME: 注释一个问题。
   
    使用 // TODO: 注释解决问题的方法。
   
    头部注释 
    ```
    /*
    * @Description:
    * @Author: OBKoro1
    * @Github: https://github.com/OBKoro1
    * @Date: 2018-10-14 17:04:37
    * @LastEditors: OBKoro1
    * @LastEditTime: 2018-11-16 16:04:42
    */
    ```
   复制代码

   函数注释

   ```
      /**
      * @description:
      * @param {type}
      * @return:
      */
    ```
   复制代码

1.5 命名规范

在命名对象、函数和实例时使用驼峰命名法,只有在命名构造器或者类或者Vue组件的时候才用帕斯卡拼命名法,文件名，文件夹一概小写
复制代码

2. 先后端分离接口规范

   2.1 api接口开发规范

   • api发送http前端统一经过POST接口发送，除了个别好比下载文件之类，发送格式content-type:application/json
   • apiName采用驼峰方式书写，格式为    控制器名/方法名
   • 接口安全性经过在header里添加accessToken来判断，在前端经过localStorage长期缓存accessToken的策略。保障安全性和跨域能力。其余的JWT开发原则还须要再约定。

   2.2  api返回参数约定

   {
     status:0, // 须要约定一些格式，好比0是正常失败, -100是登录失败
     data:{}||[],
     message:’’    // 配置提示信息，直接在前端展现
   }
   复制代码

   2.3 mock服务平台 rap

3. 发布规范

   3.1 定好项目case,建立项目分支master_case号_日期

   3.2 提交规范         修改内容

   3.3 发布规范 配置jeaneans