1. 程式人生 > >python的基本編碼風格

python的基本編碼風格

  • __xxx 類中的私有變數名
    下劃線對直譯器有特殊的意義,而且是內建識別符號所使用的符號,當變數是私有的時候,用 __xxx表示變數是很好的習慣;當時普通變數時,應避免使用這種命名風格。
    二、註釋
    註釋應簡潔、準確,放在合適的位置
    三、文件
    在模組、類宣告、函式宣告中第一個沒有賦值的字串可以用屬性obj._doc_來進行訪問,其中obj是模組、類、函式的名字。
    四、縮排
    python是通過縮排來表達程式碼邏輯的,一般使用4個空格進行縮排,但Tab製表符在不同的文字編輯器中設定不同,如果程式碼需要在不同平臺上執行,或者需要使用不同的編輯器開啟,建議不要使用Tab。
    五、識別符號名稱
    變數名稱應該簡短且意義豐富。
    六、模組結構和佈局
    #(1)起始行:只有在類Unix環境下才使用起始行,起始行的作用是能夠僅輸入指令碼名字就可執行指令碼,無需直接呼叫直譯器;
    #(2)模組文件:簡要介紹模組的功能及重要全域性變數的意義,模組外可通過module._doc_
    訪問這些內容;
    #(3)模組匯入:匯入當前模組的程式碼需要的所有模組,每個模組僅匯入一次;
    #(4)變數定義:這裡的定義的變數都是全域性變數,除非必須,否則儘量使用區域性變數代替全域性變數,以提高效能、節省記憶體;
    #(5)類定義:所有的類需要在這裡定義;
    #(6)函式定義:定義的函式可以使用module.function()在外部被訪問到;
    #(7)主程式:這裡是測試程式碼。主程式模組中有大量的頂級可執行程式碼(沒有縮排的程式碼行,在模組被匯入時就會執行),其他被匯入的模組只應該有很少的頂級執行程式碼,所有功能程式碼都應該封裝在類或者函式中。
    python標準庫中還提供了unittest模組,有時被稱為PyUnit,是一個測試框架,當需要對一個大系統的元件進行正規系統的迴歸測試時,需要使用它來進行測試。