啊對對對隊---程式碼規範與衝刺計劃
阿新 • • 發佈:2022-05-24
這個作業屬於哪個課程 | 至誠軟工實踐F班 |
---|---|
這個作業要求在哪裡 | 作業要求連結 |
這個作業的目標 | 制定程式碼規範與衝刺計劃 |
參考資料 | 華為內部程式碼規範,阿里巴巴java開發手冊 |
一、程式碼規範
1.Web前端程式碼規範
前端主要參考各個網際網路大廠的Web前端程式碼規範指南作為規範。
- 縮排
- 採用4個空格,禁止使用tab字元;
- 空格
- 二元運算子兩側必須有一個空格,一元運算子與操作物件之間不允許有空格;
- 用作程式碼塊起始的左花括號 { 前必須有一個空格;
- 函式宣告、具名函式表示式、函式呼叫中,函式名和 ( 之間不允許有空格。);
- 命名
- class 必須單詞全字母小寫,單詞間以 - 分隔;
- class 必須代表相應模組或部件的內容或功能,不得以樣式資訊進行命名;
- 同一頁面,應避免使用相同的 name 與 id;
- 元素 id 必須保證頁面唯一;
- 圖片
- 禁止 img 的 src 取值為空。延遲載入的圖片也要增加預設的 src;
- 每行最多字元數
- 120個字元
- 通用規則
- DOCTYPE:使用 HTML5 的 doctype 來啟用標準模式,建議使用大寫的 DOCTYPE;
- 編碼:頁面必須使用精簡形式,明確指定字元編碼。指定字元編碼的 meta 必須是 head 的第一個直接子元素;
- CSS 和 JavaScript 引入:引入 CSS 時必須指明 rel="stylesheet";
- JavaScript 應當放在頁面末尾,或採用非同步載入;
2.後端程式碼規範
後端主要使用阿里巴巴的Java規範;並在此基礎上,對Mapper程式碼、BO、DO、介面的寫法制定了組內規範
- 程式碼命名不能以下劃線或者美元符號開頭或者結尾;
- 程式碼命名不能以中文拼音或者中文拼音與英文混合方式;
- 類名使用UpperCamCamelCase風格,但DO、PO、DTO、VO、BO等除外;
- 方法名、引數名、變數名統一使用lowerCamelCase,必須遵守駝峰命名;
- 常量名全部大寫,單詞間用下劃線隔開;
- 抽象類必須以Abstract或者Base開頭,異常類必須以Exception結尾,測試 ;
- 類以測試的類的名稱開頭Test結尾;
- 型別與中括號緊挨相連標示陣列;
- POJO類中布林型別變數不要加is字首;
- 包名統一小寫,點分隔符有且有一個自然語義單詞;
- 避免在父子類和不同程式碼塊中採用相同變數名;
- 避免不規範的縮寫命名;
- 在對元素命名時用完整單詞組合表達其意;
- 各層命名規範:
(A) Service/DAO層命名規約
1.獲取單個物件的方法用get做字首
2.獲取多個物件的方法用list做字首,如:listObjects
3.獲取統計值的方法用count做字首
4.插入方法用save/insert做字首
5.刪除方法用delete/remove做字首
6.修改方法用update做字首
(B)領域模型命名規範
1.資料物件:xxxDO, xxx為資料庫表名
2.資料傳輸物件:xxxDTO,xxx為業務模型相關名稱
3.展示物件:xxxVO,xxx一般為網頁名稱
4.POJO是對DO、DTO、VO、BO的統稱,禁止xxxPOJO
二、衝刺任務
1.前端部分
web前臺
- 完成使用者登入、註冊、找回密碼介面
- 完成主介面:展示日曆與計劃簡略一覽
- 完成小組功能模組介面:建立、加入、退出
- 完成計劃功能模組介面:建立、編輯計劃
- 完成使用者設定修改功能模組介面:設定使用者資訊修改、密碼修改
- 前後端資料互動
web後臺
- 完成使用者登入、註冊、找回密碼介面
- 完成主介面:進入預設管理使用者資訊、左邊選單欄依次顯示使用者、計劃
- 完成計劃功能模組介面:計劃資訊稽核與修改、刪除
- 完成使用者資訊稽核功能:個人詳情稽核與修改、賬號刪除(封禁)
- 前後端資料互動
2.後端部分
計劃功能模組
- 建立、編輯計劃(編輯包括設定詳細資訊等介面)
設定功能模組
- 設定使用者資訊修改、密碼修改等介面
工具類與模組互動
- util類編寫,包含日期獲取、Json格式等工具類整合
- 功能與計劃功能互動,實現建立使用者與管理使用者計劃
雜項
- 文件撰寫
- 部落格撰寫
- 每日會議總結
3.具體日程安排
時間區間 | 任務內容 | 完成狀態 |
---|---|---|
5.20-5.21 | 進行專案環境配置、專案啟動會議 | 已完成 |
5.22-5.23 | 各模組工作初期 | 已完成 |
5.24-5.27 | 各模組任務大體完成,有基本功能實現 | 進行中 |
5.28-5.31 | 前後端互動、功能模組優化 | 進行中 |