training and sharing about clean code

1. 1
為什麼程式碼要易讀 ?

2. 2

3. 3
除了我之外
沒有人會看這 程式份
也許 會你 說
↓

4. 4

5. 5
三元運算子與一行化的愛恨情仇
return ( Z > B ) ? True : False ;
if ( Z > B ) {
return True ;
} else {
return False ;
}

6. 6
return ( Z > B ) ? True : ( X > Y ) ? True : False ;
↓
return ( Z > B ) ? True :
( X > Y ) ? True : False ;
這已經是一種性功能障礙了

7. 7
一行化的暗示
‧ 程式碼越少效率越好
‧ 一行化比較潮
‧ 看不 的人會叫我大大懂

8. 8
Naming

9. 9

10. 10
int tmp = 0;
for (int x=0; x<24; x++){
for (int y=0; y<60; y++){
for (int z=0; z<60; z++){
tmp++;
}
}
}
return tmp;

11. 11
int sumSeconds = 0;
for (int hour=0; hour<24; hour++){
for (int min=0; min<60; min++){
for (int sec=0; sec<60; sec++){
sumSeconds++;
}
}
}
return sumSeconds;

12. 12
加入額外的輔助資訊
Public int createCache(int size);
Public int createCache(int sizeByMB);
Public int createCacheByMB(int size);

13. 13
具體、具體再具體
Animal
↓
Cat
↓
Tiger

14. 14
AnAppleADayKeepTheDoctorAway
anAppleADayKeepTheDoctorAway =
New AnAppleADayKeepTheDoctorAway(“Apple”);
BestFruit bestFruit = new BestFruit(“Apple”);

15. 15
排版慣例 1
( 小 ) 駝峰式命名法
setValue
getValue
checkValue
isValue

16. 16
排版慣例 2
使用 Space 進行縮排
if (Z > B){
a = 1;
b = 2;
c = 3;
d = 4
e = 5;
}
使用 Tab 進行縮
排
if (Z > B){
a = 1;
b = 2;
c = 3;
d = 4
e = 5;
}
→

17. 17
排版慣例 3
永遠都使用大括號將 if 及迴圈語法關起來
if ( Z > B)
PK = True;
else
PK = False;
echo “Shit”;

18. 18
hashOut.data = hashes + SSL_MD5_DIGEST_LEN;
hashOut.length = SSL_SHA1_DIGEST_LEN;
if ((err = SSLFreeBuffer(&hashCtx)) != 0)
goto fail;
if ((err = ReadyHash(&SSLHashSHA1, &hashCtx)) != 0)
goto fail;
if ((err = SSLHashSHA1.update(&hashCtx, &clientRandom)) != 0)
goto fail;
if ((err = SSLHashSHA1.update(&hashCtx, &serverRandom)) != 0)
goto fail;
if ((err = SSLHashSHA1.update(&hashCtx, &signedParams)) != 0)
goto fail;
goto fail;
if ((err = SSLHashSHA1.final(&hashCtx, &hashOut)) != 0)
goto fail;

19. 19
詞不達意

20. 20
Filter, but filter what ?
filterYear(int year)
select/exclude

21. 21
邊界錯誤
閉區間 ( 包含 / 包含 )
min/max
first/last
半開放區間 ( 包含 / 不包含 )
begin/end

22. 22
布林名稱混亂
Boolean readPassword = true;
↓
Boolean isNeedPassword = true;
Prefix for Boolean : is / has / can / should

23. 23
程式的使用 明書說 - 註解

24. 24
/**
•投資決策系統
•將投資決策獨立拉出的好處是 balabala...
**/
Public void proccessInvestTask(){
if (Z>B){ // 如果利大於弊就去投資
// TODO 老 還要加入核決系統闆說
invest(); // 去投資
// TODO 下次要改名成 printReport();
showReport(); // 這段會將報表印出
}
}

25. 25
if ( B > Z) {
…
}
if ( B < Z) {
…
}
if ( Z > B) {
…
}
if ( Z < B) {
…
}

26. 26
if ( isCheck == true) {
…
}
if ( !isCheck == false) {
…
}

27. 27
不要
看窗外

28. 28
Single Responsibility Principle
單一責任原則
程式可讀性 UP~UP~UP~
解 合耦
降低維護成本
加再用性增 (Resuable)

29. 29
重構、重構再重構
Wiki : 代碼重構（ Code refactoring ）
指對軟體代碼做任何更動
以 加可讀性增
或者簡化結構
而不影響輸出結果。

30. 30
迷思：可讀性 vs 效率
nameList.contains(“ 王小明” );
nameSet.contains(“ 王小明” );

31. 31
人非聖賢
寫就對了
Just do it!

32. 32
Q & A