作業格式

• 課程名稱：軟件工程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

轉載于:https://www.cnblogs.com/sosd/p/10759592.html

總結

以上是生活随笔為你收集整理的项目Alpha冲刺——代码规范、本次冲刺任务与计划的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。