擴充套件01:程式碼風格/python規範style

李鸣源發表於2024-12-05

一.風格介紹
修飾的前提是“跑通”程式碼,也就是說先確保你的code沒有任何bug
這種“修飾”並不是對每一個都強制學習的內容

二.縮排與換行
1.縮排
1.)如果有開始定界符,其餘行的縮排需與開始定界符對齊。
2.)需要額外的4個空格(長度相當於一個Tab鍵),以區分開傳入引數,和其他內容。
3.)空格一般用於新增以上這種縮排,Tab鍵一般用於保持行與行之間的一致性
4.)多行if語句銜接,需要一個額外的縮排,以區分其他內容
2.換行
1.)將所有行限制為最多79個字元。
2.)一般語句接受“隱式”延續,但是with語句等不支援,需要使用、來銜接
3.)另一個這樣的例子是assert語句
4.)多行if語句的縮排
5.)通常不鼓勵使用符合語句(同一行上的多個語句)

三.匯入規範
1.import本地模組、包
1.)當我們需要匯入本地自己封裝好的一些模組時,需要import來匯入
2.)如果我們需要在m1.py檔案中匯入同目錄下的m2.py檔案,直接匯入即可

四.關於空格
1.緊接在圓括號、方括號或大括號內,不需要多餘空格
2.在逗號,分號或冒號之前,尾隨逗號之後均不需要多餘空格
3.在切片中,兩個冒號必須應用相同的間距
4.緊接在開始函式呼叫的引數列表的左括號之前,不需要多餘空格
5.賦值(或其他)運算子周圍需要多個空格以使其與另一個運算子對齊

五.程式碼註釋
1.註釋就是對程式碼的解釋和說明,目的是讓人們能夠更加輕鬆的瞭解程式碼
2.註釋是編寫程式時,寫程式的人給一個語句,程式段,函式等的解釋或提示,能提高程式碼可讀性
3.在有處理邏輯的程式碼中,源程式有效註釋量必須在20%以上

六.命名規範
1.不要將python關鍵字和函式名用作變數名,即不要使用python保留用於特殊用途的單詞
2.變數名與函式名簡短且有描述性

相關文章