項目Alpha衝刺——代碼規範、本次衝刺任務與計劃

做業格式

• 課程名稱：軟件工程1916|W（福州大學）
• 做業要求：項目Alpha衝刺（團隊）
• 團隊名稱： 那周餘嘉熊掌將得隊
• 做業目標：代碼規範、本次衝刺任務與計劃
• 團隊信息：

隊員學號	隊員姓名	博客地址	備註
221600131	Jamin	https://www.cnblogs.com/JaminWu/	隊長
221600308	我超可愛的	http://www.cnblogs.com/XNC-SoCute/
221600305	haziza	http://www.cnblogs.com/haziza/
221600340	你看見個人小熊了嗎	https://www.cnblogs.com/stereohearts/
221600426	Hunterj Lin	https://www.cnblogs.com/HunterJ/
021600823	玫葵	https://www.cnblogs.com/offeroques/

做業正文

1. 項目準備

• 項目選題報告

• 項目原型設計

• 項目需求分析

• 項目系統設計與數據庫設計

2. 代碼規範

前端

• 目錄規範
  • build文件夾 —— 放置webpack配置文件
    • build.js文件 —— 生產環境構建
    • dev-server.js文件 —— npm run dev的啓動文件 構建本地服務器
    • dev-client.js文件 —— 開發服務器的熱重載
    • check-version.js文件 —— 檢查node、npm版本
    • utils.js —— 構建工具相關
    • webpack.base.conf.js文件 —— webpack基礎配置
    • webpack.dev.conf.js文件 —— webpack開發環境配置
    • webpack.prod.conf.js文件 —— webpack生產環境配置
    • vue-loader文件 —— css加載器配置
  • config文件夾 —— 放置Vue項目配置文件
    • index.js文件 —— 項目主要配置（包括監聽端口，打包路徑等）
    • dev.env.js —— 項目開發環境配置
    • prod.env.js —— 項目生產環境配置
  • node_modules文件夾 —— 放置依賴包
  • src文件夾 —— 項目核心文件
    • assets文件夾 —— 放置樣式及靜態圖片等
    • components文件夾 —— 項目全部組件
    • views文件夾 —— 項目全部頁面
    • script文件夾 —— 外部js文件
  • static文件夾 —— 第三方插件、靜態資源等
  • app.Vue文件 —— 頁面入口文件
  • main.js文件 —— 項目入口文件
  • index.js文件 —— 入口頁面及路由配置
  • .babelrc文件 —— ES6語法編譯配置
  • .editorconfig —— 定義代碼格式
  • .gitignore —— git上傳須要忽略的文件格式
  • .postcssrc —— postcss配置文件
  • package.json —— 項目基本信息、依賴信息等
• 命名風格
  • 代碼中的命名均不能如下劃線或美圓符號開始，也不能如下劃線或美圓符號結束。
  • 代碼中的命名不容許使用拼音與英文混合的方式，更不容許直接使用中文的方式。
  • 類名儘可能使用UpperCamelCase風格，方便閱讀。
  • 方法名、參數名、成員變量、局部變量都儘可能使用 lowerCamelCase 風格，儘可能聽從駝峯形式。
  • 包名統一使用小寫，點分隔符之間有且僅有一個天然語義的英語單詞。包名統一使用單數形式，可是類名若是有複數含義，類名可使用複數形式。
  • 爲了達到代碼自解釋的目標，任何自定義編程元素在命名時，使用盡可能完整的單詞組合或單詞縮寫來表達其意。
• 代碼格式
  • if/for/while/switch/do 等保留字與括號之間都必須加空格。
  • 對於非空代碼塊的大括號使用中，表示終止的右大括號後必須換行；左大括號後換行；右大括號前換行。
  • 可以使用tab縮進或4個空格縮進。
  • css樣式部分使用sass語句，子元素樣式都寫在父元素樣式裏。
• 註釋規約
  • 方法內部單行註釋，在被註釋語句上方另起一行，使用//註釋。
  • 方法內部多行註釋 使用/* */註釋，注意與代碼對齊。
  • 代碼修改的同時，註釋也要進行相應的修改，尤爲是參數、返回值、異常、核心邏輯等的修改。
  • 謹慎註釋掉代碼。在上方詳細說明，而不是簡單地註釋掉。若是無用，則刪除。

後端

• 命名風格
  • 大小寫約定
    • 請將PascalCasing 用於包含多個單詞的全部公共成員、類型和命名空間名稱。
    • 請將camelCasing 用於參數名稱。
  • 通用命名約定
    • 務必選擇易讀的標識符名稱。
    • 務必使可讀性優先於簡潔性。
    • 不要使用下劃線、連字符或任何其餘非字母數字字符。
    • 避免使用與普遍應用的編程語言關鍵字衝突的標識符。
    • 不要在標識符名稱中使用縮寫形式或縮略形式。
    • 不要使用任何不經常使用的首字母縮寫形式，即便是經常使用形式，也應只在必要時使用。
    • 務必使用在語義上有意義的名稱而不是特定於語言的關鍵字做爲類型名稱。
  • 類、結構和接口得名稱
    • 務必經過使用PascalCasing，用名詞或名詞短語命名類和結構。
    • 務必使用形容詞短語命名接口，或偶爾用名詞或名詞短語命名接口。
    • 務必在接口名稱前加上字母I做爲前綴，以指示該類型是接口。
    • 務必確保在定義類和接口對時，類名稱和接口名稱的區別僅在於 "I" 前綴，其中類是接口的標準實現。
• 代碼格式
  • 採用4個空格縮進，禁止使用tab字符。
  • 括號的使用約定。若是是大括號內爲空，則簡潔地寫成{}便可，不須要換行；若是是非空代碼塊則：左大括號前換行,左大括號後換行,右大括號前換行,右大括號後換行。
  • if/for/while/switch/do 等保留字與括號之間都必須加空格
  • 方法參數在定義和傳入時，多個參數逗號後邊必須加空格
• 註釋規約
  • 用途使用<summary>註釋
  • 參數使用<params>註釋
  • 返回值使用<returns>註釋
  • 方法內部單行註釋，在被註釋語句上方另起一行，使用//註釋。方法內部多行註釋 使用/* */註釋，注意與代碼對齊。

git協做規範

• master分支，即主分支。任何項目都必須有個這個分支。對項目進行tag或發佈版本等操做，都必須在該分支上進行。

• develop分支，即開發分支，從master分支上檢出。團隊成員通常不會直接更改該分支，而是分別從該分支檢出本身的feature分支，開發完成後將feature分支上的改動merge回develop分支。同時release分支由此分支檢出。

• release分支，即發佈分支，從develop分支上檢出。該分支用做發版前的測試，可進行簡單的bug修復。若是bug修復比較複雜，可merge回develop分支後由其餘分支進行bug修復。此分支測試完成後，須要同時merge到master和develop分支上。

• feature分支，即功能分支，從develop分支上檢出。團隊成員中每一個人都維護一個本身的feature分支，並進行開發工做，開發完成後將此分支merge回develop分支。此分支通常用來開發新功能或進行項目維護等。

• fix分支，即補丁分支，由develop分支檢出，用做bug修復，bug修復完成需merge回develop分支，並將其刪除。因此該分支屬於臨時性分支。

• hotfix分支，即熱補丁分支。該分支由master分支檢出，進行線上版本的bug修復，修復完成後merge回master分支，並merge到develop分支上，merge完成後也能夠將其刪除，也屬於臨時性分支。

  3. 衝刺任務與計劃

序號	任務與計劃	時間
第一天	搭建gitlab，配置環境，整理概括組件並複用底層代碼，學習新技術	4.25
次日	前端封裝客戶端首頁、登錄註冊、忘記密碼、實驗室介紹組件； 後端編寫model類	4.26
第三天	前端封裝客戶端我的中心、實驗室納新組件； 後端編寫登錄註冊、忘記密碼、我的中心、實驗室納新對應接口	4.27
第四天	先後端實現已完成組件的數據傳輸； 後端編寫對應接口	4.28
第五天	前端拼接首頁、登錄註冊、我的中心、納新頁面； 後端完善接口功能	4.29
第六天	前端封裝客戶端賽事模塊組件； 後端編寫對應接口	4.30
第七天	前端封裝管理員端賽事模塊組件； 後端完善接口功能	5.1
第八天	先後端交接賽事模塊並拼接； 後端完善接口功能	5.2
第九天	前端編寫實驗室介紹、成員風采、做品展現等組件並先後端交接； 後端編寫對應接口	5.3
第十天	前端整理已完成頁面路由並優化組件，以及使用Vuex全局控制變量； 後端完善接口功能	5.4