天天看點

TimeMaster—代碼規範、沖刺任務與計劃

這個作業屬于哪個課程 2020春|S班
這個作業要求在哪裡 團隊作業第五次——站立式會議+alpha沖刺
團隊名稱 TimeMaster
這個作業的目标 完成本次沖刺的代碼規範編寫、本次沖刺任務與計劃規劃
作業正文 TimeMaster——代碼規範、沖刺任務與計劃
其他參考文獻 《阿裡巴巴Java開發手冊終極版v1.3.0》

1. 編碼風格

1.1 程式設計規約

1.1.1 命名風格

1.代碼命名不以下劃線或美元符開頭

2.代碼命名不以拼音英文混合

3.類名以UpperCamelCase,駝峰命名

4.包名小寫

5.變量名、參數名、方法名LowerCamelCase,駝峰命名

6.允許常用單詞縮寫,但是不建議

7.方法名盡量展現動作意義

8.插入使用add、删除使用delete、更新使用update

9.實作類采用Impl字尾

10.接口子產品等采用設計模式可以從命名展現

1.1.2 常量定義

1.不允許出現魔法值

2.long型應采用L表示避免看錯

1.1.3 代碼格式

1.大括号為空則不換行、其他情況為左括号前不換行後換行、右大括号前換行後換行(else除外)

2.括号旁不加空格(保留字除外)、運算符兩側加上空格

3.縮進采用一個tab

4.代碼塊必須大括号圍住

5.單行最大代碼長度120個字元

6.參數傳遞時逗号後加一個空格

1.1.4 OOP規約

1.通路靜态方法通過類名

2.重寫方法加上@override

3.避免對象調用的空指針,盡可能使用常量或确有值對象調用方法

4.包裝類對象值比較采用equals

5構造方法不要放入業務邏輯

6.同名方法放在一起

7.getter、setter方法不增加業務邏輯

1.1.5 控制語句

1.減少if-else格式嵌套,如果可以直接傳回建議直接傳回

2.複雜判斷不要直接放入判斷條件中,可以增加變量儲存

3.循環增加性能,避免在循環體内重複的不必要操作

1.1.6 注釋

1.類、屬性、方法采用/内容/注釋

2.内部單行采用//、多行采用/内容/

3.代碼與注釋修改同步

4.中文注釋推薦

5.注釋力求節儉

1.2 資料庫編碼規約

1.2.1 建表規約

1.表名字段名小寫、避免出現數字和複數、謹慎字段名

2.字段盡量表達資料意義

3.禁止使用保留字

4.允許适當備援(操作較少字段)

5.内容太大時建議單獨建表,提高查詢效率

6.每張表為主鍵自增id

1.2.2 SQL語句

1.使用官方推薦的count(*)形式,不适用count(字段)

2.查詢資料量大時使用分頁查詢、當總數查詢為0時,立即傳回結果

3.不使用過程

4.不使用拼接SQL語句

2. 沖刺任務

本次沖刺任務是:通過十天的編碼沖刺和站立式會議,完成程式的alpha版本。

完成alpha版本的基本功能:注冊、登入、待辦/待辦集使用、資料統計、寵物、團隊等,其中寵物和團隊可能會有嚴重缺陷,需要測試完善。

3. 沖刺計劃

天數 任務計劃
1 開始完成登入注冊
2-3 完成待辦/待辦集顯示和使用記錄
4-5 完成鎖屏
6 完成資料統計顯示
7-8 完成寵物
9-10 完成團隊