班級:軟體工程1916|W
作業:項目Beta沖刺(團隊)
團隊名稱:Echo
作業目标:規定代碼規範,明确沖刺任務與計劃
目錄
- 團隊部落格彙總
- 讨論組長是否重選的議題和結論
- 下一階段需要改進完善的功能
- 下一階段新增的功能
- 需要改進的團隊分工
- 需要改進的工具流程
- 沖刺的時間計劃安排
- 代碼規範
團隊部落格彙總
隊員學号 | 隊員姓名 | 個人部落格位址 | 備注 |
---|---|---|---|
221600136 | 張至鋒 | https://www.cnblogs.com/love2i/ | |
221600418 | 黃少勇 | http://www.cnblogs.com/huangshaoyong | |
221600420 | 黃種鑫 | http://www.cnblogs.com/huangzhongxin | 隊長 |
221600422 | 李東權 | http://www.cnblogs.com/Ldqblogs | |
221600425 | 林弘傑 | http://www.cnblogs.com/lhj20190212 |
讨論組長是否重選的議題和結論
經過讨論,隊長不變
下一階段需要改進完善的功能
- 完善web端員工資訊管理子產品的增加與修改功能
- 完善web端繳費資訊的增加功能
下一階段新增的功能
-
小程式端:
1.1 檢視、回複報修内容
1.2 檢視、回複投訴内容
-
web端:
2.1 檢視、回複報修内容
2.2 檢視、回複投訴内容
2.3 人員資訊、繳費資訊、住宿資訊上傳
需要改進的團隊分工
繼續按照之前方式進行團隊分工
需要改進的工具流程
暫無
沖刺的時間計劃安排
任務 | 時間 | |
---|---|---|
Beta沖刺Day1 | web前端:修改Alpha階段遺留問題 -- 錯誤提示不友好 web後端:實作檔案上傳功能 小程式前端:界面微調 小程式後端:報修内容回複及查詢功能接口 | 5.24 |
Beta沖刺Day2 | web前端:人員等資訊上傳功能實作 web後端:報修内容回複及查詢功能接口 小程式前端:報修回複界面編寫 小程式後端:報修内容回複及查詢功能接口 | 5.25 |
Beta沖刺Day3 | web前端:報修回複界面編寫 web後端:報修内容回複及查詢功能接口 小程式前端:對接報修内容回複及查詢功能接口 小程式後端:對接報修内容回複及查詢功能接口 | 5.26 |
Beta沖刺Day4 | web前端:報修回複界面編寫及接口對接 web後端:對接報修内容回複及查詢功能接口 小程式前端:投訴回複界面編寫 小程式後端:投訴内容回複及查詢功能接口 | 5.27 |
Beta沖刺Day5 | web前端:報修回複界面編寫及接口對接、投訴回複界面編寫 web後端:投訴内容回複及查詢功能接口 小程式前端:對接投訴内容回複及查詢功能接口 小程式後端:對接投訴内容回複及查詢功能接口 | 5.28 |
Beta沖刺Day6 | web前端:對接投訴内容回複及查詢功能接口 web後端:對接投訴内容回複及查詢功能接口 小程式端:協助web端進行聯調 | 5.29 |
Beta沖刺Day7 | 聯調、測試 | 5.30 |
Beta沖刺Day8 | 使用者總結報告 | 5.31 |
代碼規範
前端
一、檔案組織形式
- 所有項目源代碼請放在項目根目錄
src
目錄下,項目所需最基本的檔案包括 入口檔案 以及 頁面檔案
入口檔案為
,頁面檔案建議放置在app.js
目錄下src/pages
- Taro 中普通 JS/TS 檔案以小寫字母命名,多個單詞以下劃線連接配接,例如
、util.js
util_helper.js
- Taro 元件檔案命名遵循 Pascal 命名法
- Taro 中普通 JS/TS 檔案以
或者.js
作為檔案字尾.ts
- Taro 元件則以
或者.jsx
作為檔案字尾,當然這不是強制限制,隻是作為一個實踐的建議,元件檔案依然可以以.tsx
或者.js
作為檔案字尾.ts
二、JavaScript 書寫規範
- 使用兩個空格進行縮進
- 字元串統一使用單引号
- 關鍵字後面加空格,函數聲明時括号與函數名間加空格
- 屬性前面不要加空格
- 遇到分号時空格要後留前不留,逗号後面加空格,始終将逗号置于行末
- 鍵值對當中冒号與值之間要留白格
- 對于變量和函數名統一使用駝峰命名法
- 不重複聲明變量,不定義未使用變量
- 對象定義存值器,一定要對于的定義取值器
- 對象屬性轉行時注意統一代碼風格
- 不定義備援的函數參數,避免多餘的函數上下文綁定,嵌套代碼塊中禁止再次定義函數
- 類名以大寫字母開頭,子類構造器一定要調用super,使用this之前確定super已調用
- 同一子產品有多個導入時一次性寫完,return、throw、continue和break後不再跟代碼
- 使用===代替==,if/else關鍵字要與花括号儲存在同一行
- 避免使用常量作為條件表達式條件(循環語句除外)
三、元件及JSX書寫規範
- 元件以類的形式進行建立,并且當個檔案中隻能存在當個元件
- 使用兩個空格進行縮進,不要混合使用空格與制表符作為縮進
- JSX 屬性均使用單引号
- 多個屬性,多行書寫,每個屬性占用一行,标簽結束另起一行
- 終始在自閉合标簽前面添加一個空格
- 屬性名稱始終使用駝峰命名法
- 用括号包裹多行 JSX 标簽
- 當标簽沒有子元素時,始終使用自閉合标簽
- 事件綁定均以on開頭,子元件傳入函數時屬性名需要以on開頭
後端
一、命名規則
- 類名統一使用UpperCamelCase風格,如XmlService
- 方法名,參數名,成員變量,局部變量統一使用lowerCamelCase風格,如inputUserId
- 常量命名全部大寫,單詞間用下劃線隔開,如MAX_STOCK_COUNT
-
抽象類命名使用 Abstract 或 Base 開頭;異常類命名使用 Exception 結尾;測試類
命名以它要測試的類的名稱開始,以 Test 結尾
- 類型與中括号緊挨相連來表示數組
-
包名統一使用小寫,點分隔符之間有且僅有一個自然語義的英語單詞。包名統一使用
單數形式
-
Service/DAO 層方法命名規約
1) 擷取單個對象的方法用 get 做字首。
2) 擷取多個對象的方法用 list 做字首,複數形式結尾如:listObjects。
3) 擷取統計值的方法用 count 做字首。
4) 插入的方法用 save/insert 做字首。
5) 删除的方法用 remove/delete 做字首。
6) 修改的方法用 update 做字首。
二、代碼風格
- 采用 4 個空格縮進,禁止使用 tab 字元
- if/for/while/switch/do 等保留字與括号之間都必須加空格
- 注釋的雙斜線與注釋内容之間有且僅有一個空格
- 方法參數在定義和傳入時,多個參數逗号後邊必須加空格
- 所有的覆寫方法,必須加@Override 注解
- 所有的相同類型的包裝類對象之間值的比較,全部使用 equals 方法比較
- finally 塊必須對資源對象、流對象進行關閉,有異常也要做 try-catch
三、應用分層
圖中預設上層依賴于下層,箭頭關系表示可直接依賴,如:開放接口層可以依賴于
Web 層,也可以直接依賴于 Service 層,依此類推:
-
開放接口層:可直接封裝 Service 方法暴露成 RPC 接口;通過 Web 封裝成 http 接口;進行
網關安全控制、流量控制等。
-
終端顯示層:各個端的模闆渲染并執行顯示的層。目前主要是 velocity 渲染,JS 渲染,
JSP 渲染,移動端展示等。
- Web 層:主要是對通路控制進行轉發,各類基本參數校驗,或者不複用的業務簡單處理等。
- Service 層:相對具體的業務邏輯服務層。
- DAO 層:資料通路層,與底層 MySQL、Oracle、Hbase 等進行資料互動。
轉載于:https://www.cnblogs.com/magicNumber/p/10913967.html