代碼規范及編碼原則


代碼規范及編碼原則

1.1

代碼風格的原則是:簡明,已讀,無二義性。每一個優秀的程序員都應該遵循代碼規范及編碼原則。

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

1.2

程序風格:

1縮進:4個空格

2行寬:限制行寬

3括號:在復雜的條件表達式中,用括號清楚地表示邏輯優先級

4{}號:每個{}號獨占一行

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

變量

命名規則
(1) 變量名的命名規則; 
分析:變量名的命名規則遵循用戶自定義標識符命名規則 
1) 只能由字母、數字、下划線組成; 
2) 第一個字符必須是英文字母;
3) 有效長度為255個字符; 
4) 不可以包含標點符號和類型說明符%,&,!,# ,@,$
5) 不可以是系統的關鍵詞比如else

注釋

1、多余的注釋要舍棄

2、復雜的注釋放在函數頭

函數,過程

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

4.函數的功能應該是可以預測的,也就是只要輸入數據相同就應產生同樣的輸出。 

5.函數的命名法應使用駝峰命名法或者下划線命名法,駝峰和下划線不能同時使用。

 除了此書外,《Clean Code》也可以幫助程序員學習代碼規范。

下面是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

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM