程式碼規範及編碼原則

1.1

程式碼風格的原則是：簡明，已讀，無二義性。每一個優秀的程式設計師都應該遵循程式碼規範及編碼原則。

讀了《構建之法》第四章後，我們組進行簡潔總結。

1.2

程式風格：

1、縮排：4個空格

2、行寬：限制行寬

3、括號：在複雜的條件表示式中，用括號清楚地表示邏輯優先順序

4、{}號：每個{}號獨佔一行

5、分行：不要把多條語句放在一行

變數

命名規則
(1) 變數名的命名規則；
分析：變數名的命名規則遵循使用者自定義識別符號命名規則
（1） 只能由字母、數字、下劃線組成；
（2） 第一個字元必須是英文字母；
（3） 有效長度為255個字元；
（4） 不可以包含標點符號和型別說明符

註釋

1、多餘的註釋要捨棄

2、複雜的註釋放在函式頭

函式，過程

1.函式的規模儘量限制在200行以內。 　　
2.一個函式最好僅完成一件功能。 　　
3.為簡單功能編寫函式。

4.函式的功能應該是可以預測的，也就是隻要輸入資料相同就應產生同樣的輸出。

5.函式的命名法應使用駝峰命名法或者下劃線命名法，駝峰和下劃線不能同時使用。

下面是Clean Code讀書筆記

一、整潔程式碼
1. 概念 
         程式碼正確   
         簡潔明瞭
        清晰易讀  
        短小精確
二、命名    
      
 
1.準確：
       名字與意義匹配     
        易於區別      
      2.實用 
    使用讀的出來的名稱   
    使用可搜尋的名稱  
       3.明確    
    一個概念對應一個詞  
    不用雙關語   
    使用有意義的語境   
三、函式
      1.短小
      2.職責單一
      3.一塊程式碼中，函式的抽象層級需一致
      4.函式命名規範（參照二）
      5.引數儘可能少
      6.如果函式需要的引數要求數量有多種，應考慮將其封裝成類
      7.實用異常類代替返回錯誤碼，抽離try/catch程式碼塊，使程式碼更加簡潔
四、註釋
      
 
1.少用註釋，儘可能通過規範的程式碼來表達
      2.不使用無意義的註釋
      3.必要的註釋：
     法律資訊
    提供資訊的註釋
    對程式碼意圖進行解釋的註釋
    警示資訊，防止踩坑
    TODO註釋：未來得及完成的部分
     4. 對於無用的程式碼應直接刪除而不是註釋
五、格式
       1.為什麼需要規範格式
    易維護
    易拓展
       2.垂直格式
    行數少，短小精悍
    概念隔離，不同的的概念/邏輯 程式碼實用空行隔離
    相關靠近：對於關係緊密的程式碼，儘量寫在一起
       3.水平格式
    縮排、對齊
六、物件與資料結構
       1.區別：
    過程式程式碼便於在不改動既有資料結構的前提下新增新函式
    面向物件程式碼便於在不改動既有函式的前提下新增新類
        亦即：
    過程式程式碼難以新增新資料結構，因為必須修改所有函式
    面向物件程式碼難以新增新函式，因為必須修改所有類
七、錯誤處理
       1.使用異常而非返回碼：
    更加美觀、整潔
       2.使用不可控異常
    可控異常的代價是違反開放／閉合原則，因為你需要在使用的地方捕獲異常
       3.在異常發生的地方新增環境說明：
    這樣當異常發生的時候就可以根據這些資訊定位異常原因
       4.不返回null 也不傳遞null
    這樣在接收的時候不需要進行空值檢查
八、邊界
       翻了下原書，邊界是Boundaries   對於這個名字，開始不是大理解，就算現在看來也還是覺得不直觀
      標題略晦澀：作者的意思應該是讓我們讓自己的程式碼和第三方庫程式碼不要耦合太緊密，需有清新的邊界
       對於第三方類庫給的學習建議是：探索性地學習測試，以此熟悉類庫，寫出良好的程式碼

來源：

https://blog.csdn.net/mummyding/article/details/51326238