前端編碼規範

編碼規範

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