- 好的名字不需要註解
- 小函式/區域中,才使用無意義/單一字母的名字
- 容易被搜尋
- 物件用名詞
- 函式用動詞 is/has/get/set/cal
- 變數:小寫大寫大寫 frameSizeLength
- 參數:大寫_大寫 MAX_LENGTH
- 在25個字母以內
- 是非題用bool(由函式retuen)宣告,判斷式中直接用
bool isFinish if( isFinish )
- 先試圖改變程式碼,不得已再來新增註解
- 別廢話,簡短說明目的
- 可在開頭放版權、公司規範
- 勿刪、勿動的警告
- 挑好名稱比打註解有價值
- 不等式、分號左右需要空白、括弧旁不需要
if(i > 1) for(int i = 0 ; i < 100 ; i++)
- 所有變數均使用private,再以getter/setter存取
- 以re-assign代替declare
- 完成所有可能經歷到的測試(單元測試)
- 避免重複的程式碼(以互相呼叫副函式取代)
- 內容具表達力(好名稱、短函式)
- 每個執行緒僅有單一職責
- 使用資料的複本,勿共享
- 應可以獨立運作
- 註解能刪就刪,保留不得已存在的
- 若有註解掉的程式碼,要附註使用時機
- 函式輸入參數最好不要超過三個
- 函式名稱要和將完成的行為為有關
- 團隊要先擬定變數和函式的命名規則、擺放位置
- 注意邊界問題(Boundary)
- 不呼叫物件中的物件中的值
- 若程式視野涵蓋很廣,變數名稱要用越長(完整)來解釋