作業(yè)格式

• 課程名稱：軟件工程1916|W（福州大學(xué)）
• 作業(yè)要求：項(xiàng)目Alpha沖刺（團(tuán)隊(duì)）
• 團(tuán)隊(duì)名稱： 那周余嘉熊掌將得隊(duì)
• 作業(yè)目標(biāo)：代碼規(guī)范、本次沖刺任務(wù)與計(jì)劃
• 團(tuán)隊(duì)信息：

隊(duì)員學(xué)號(hào)隊(duì)員姓名博客地址備注

221600131	Jamin	https://www.cnblogs.com/JaminWu/	隊(duì)長(zhǎng)
221600308	我超可愛(ài)的	http://www.cnblogs.com/XNC-SoCute/
221600305	haziza	http://www.cnblogs.com/haziza/
221600340	你看見(jiàn)我的小熊了嗎	https://www.cnblogs.com/stereohearts/
221600426	Hunterj Lin	https://www.cnblogs.com/HunterJ/
021600823	玫葵	https://www.cnblogs.com/offeroques/

作業(yè)正文

1. 項(xiàng)目準(zhǔn)備

• 項(xiàng)目選題報(bào)告

• 項(xiàng)目原型設(shè)計(jì)

• 項(xiàng)目需求分析

• 項(xiàng)目系統(tǒng)設(shè)計(jì)與數(shù)據(jù)庫(kù)設(shè)計(jì)

2. 代碼規(guī)范

前端

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

后端

• 命名風(fēng)格
  • 大小寫約定
    • 請(qǐng)將PascalCasing 用于包含多個(gè)單詞的所有公共成員、類型和命名空間名稱。
    • 請(qǐng)將camelCasing 用于參數(shù)名稱。
  • 通用命名約定
    • 務(wù)必選擇易讀的標(biāo)識(shí)符名稱。
    • 務(wù)必使可讀性優(yōu)先于簡(jiǎn)潔性。
    • 不要使用下劃線、連字符或任何其他非字母數(shù)字字符。
    • 避免使用與廣泛應(yīng)用的編程語(yǔ)言關(guān)鍵字沖突的標(biāo)識(shí)符。
    • 不要在標(biāo)識(shí)符名稱中使用縮寫形式或縮略形式。
    • 不要使用任何不常用的首字母縮寫形式，即使是常用形式，也應(yīng)只在必要時(shí)使用。
    • 務(wù)必使用在語(yǔ)義上有意義的名稱而不是特定于語(yǔ)言的關(guān)鍵字作為類型名稱。
  • 類、結(jié)構(gòu)和接口得名稱
    • 務(wù)必通過(guò)使用PascalCasing，用名詞或名詞短語(yǔ)命名類和結(jié)構(gòu)。
    • 務(wù)必使用形容詞短語(yǔ)命名接口，或偶爾用名詞或名詞短語(yǔ)命名接口。
    • 務(wù)必在接口名稱前加上字母I作為前綴，以指示該類型是接口。
    • 務(wù)必確保在定義類和接口對(duì)時(shí)，類名稱和接口名稱的區(qū)別僅在于 "I" 前綴，其中類是接口的標(biāo)準(zhǔn)實(shí)現(xiàn)。
• 代碼格式
  • 采用4個(gè)空格縮進(jìn)，禁止使用tab字符。
  • 括號(hào)的使用約定。如果是大括號(hào)內(nèi)為空，則簡(jiǎn)潔地寫成{}即可，不需要換行；如果是非空代碼塊則：左大括號(hào)前換行,左大括號(hào)后換行,右大括號(hào)前換行,右大括號(hào)后換行。
  • if/for/while/switch/do 等保留字與括號(hào)之間都必須加空格
  • 方法參數(shù)在定義和傳入時(shí)，多個(gè)參數(shù)逗號(hào)后邊必須加空格
• 注釋規(guī)約
  • 用途使用<summary>注釋
  • 參數(shù)使用<params>注釋
  • 返回值使用<returns>注釋
  • 方法內(nèi)部單行注釋，在被注釋語(yǔ)句上方另起一行，使用//注釋。方法內(nèi)部多行注釋 使用/* */注釋，注意與代碼對(duì)齊。

git協(xié)作規(guī)范

• master分支，即主分支。任何項(xiàng)目都必須有個(gè)這個(gè)分支。對(duì)項(xiàng)目進(jìn)行tag或發(fā)布版本等操作，都必須在該分支上進(jìn)行。

• develop分支，即開發(fā)分支，從master分支上檢出。團(tuán)隊(duì)成員一般不會(huì)直接更改該分支，而是分別從該分支檢出自己的feature分支，開發(fā)完成后將feature分支上的改動(dòng)merge回develop分支。同時(shí)release分支由此分支檢出。

• release分支，即發(fā)布分支，從develop分支上檢出。該分支用作發(fā)版前的測(cè)試，可進(jìn)行簡(jiǎn)單的bug修復(fù)。如果bug修復(fù)比較復(fù)雜，可merge回develop分支后由其他分支進(jìn)行bug修復(fù)。此分支測(cè)試完成后，需要同時(shí)merge到master和develop分支上。

• feature分支，即功能分支，從develop分支上檢出。團(tuán)隊(duì)成員中每個(gè)人都維護(hù)一個(gè)自己的feature分支，并進(jìn)行開發(fā)工作，開發(fā)完成后將此分支merge回develop分支。此分支一般用來(lái)開發(fā)新功能或進(jìn)行項(xiàng)目維護(hù)等。

• fix分支，即補(bǔ)丁分支，由develop分支檢出，用作bug修復(fù)，bug修復(fù)完成需merge回develop分支，并將其刪除。所以該分支屬于臨時(shí)性分支。

• hotfix分支，即熱補(bǔ)丁分支。該分支由master分支檢出，進(jìn)行線上版本的bug修復(fù)，修復(fù)完成后merge回master分支，并merge到develop分支上，merge完成后也可以將其刪除，也屬于臨時(shí)性分支。

  3. 沖刺任務(wù)與計(jì)劃

序號(hào)任務(wù)與計(jì)劃時(shí)間

第一天	搭建gitlab，配置環(huán)境，整理歸納組件并復(fù)用底層代碼，學(xué)習(xí)新技術(shù)	4.25
第二天	前端封裝客戶端首頁(yè)、登陸注冊(cè)、忘記密碼、實(shí)驗(yàn)室介紹組件； 后端編寫model類	4.26
第三天	前端封裝客戶端個(gè)人中心、實(shí)驗(yàn)室納新組件； 后端編寫登陸注冊(cè)、忘記密碼、個(gè)人中心、實(shí)驗(yàn)室納新對(duì)應(yīng)接口	4.27
第四天	前后端實(shí)現(xiàn)已完成組件的數(shù)據(jù)傳輸； 后端編寫對(duì)應(yīng)接口	4.28
第五天	前端拼接首頁(yè)、登陸注冊(cè)、個(gè)人中心、納新頁(yè)面； 后端完善接口功能	4.29
第六天	前端封裝客戶端賽事模塊組件； 后端編寫對(duì)應(yīng)接口	4.30
第七天	前端封裝管理員端賽事模塊組件； 后端完善接口功能	5.1
第八天	前后端交接賽事模塊并拼接； 后端完善接口功能	5.2
第九天	前端編寫實(shí)驗(yàn)室介紹、成員風(fēng)采、作品展示等組件并前后端交接； 后端編寫對(duì)應(yīng)接口	5.3
第十天	前端整理已完成頁(yè)面路由并優(yōu)化組件，以及使用Vuex全局控制變量； 后端完善接口功能	5.4

轉(zhuǎn)載于:https://www.cnblogs.com/sosd/p/10759592.html

總結(jié)

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

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。