縮進程序員
4個空格縮進編輯器
行長函數
建議每行不超過80個字符,每行只能容納79個字符測試
註釋的行長不超過72個字符進程
空行文檔
如5行建立列表的代碼和三行處理列表的代碼,用一個空行把兩部分隔開,不該該用三四行空行隔開字符串
空行不會影響代碼的運行,但會影響代碼的可讀性import
條件測試的格式設置方面,在如==、<=、>=等比較運算符兩邊各添加一個空格,例如if age < 4比if age<4好程序
函數方法
編寫函數時,要給函數指定描述性名稱,只能用小寫字母和下劃線,給模塊命名也要遵照上述約定
每一個函數要包含簡要的闡述其功能的註釋,註釋緊跟函數定義後面,採用文檔字符串的格式,文檔良好的函數讓其餘程序員只要閱讀文檔字符串中的描述就可以使用它
只要知道函數的名稱,須要的實參以及返回值的類型,就能在本身的程序中使用它
給形參指定默認值時,等號兩邊不要有空格,關鍵字實參也同樣
若是形參不少超過了79字符,能夠在函數定義中輸入左括號加上回車鍵,在下一行按兩下tab,將形參列表和只縮進一層的函數體區分開來,
大多數編輯器都會自動對齊後序參數列表行,縮進程度與你給第一個參數列表行指定的縮進程度相同
若是程序包含多個函數,能夠使用兩個空行把相鄰的函數分開,這樣更容易知道前一個函數在什麼地方結束,後一個函數在什麼地方開始
全部的import語句都應該放在文件的開頭,除非文件開頭有註釋
類
類名應該使用駝峯命名法,即類名中的每一個首字母都要大寫,而不使用下劃線,實例名和模塊名都使用小寫格式,並在單詞之間加上下劃線
每一個類都應該在類定義後包含一個文檔字符串,簡要的描述類的功能,並遵循編寫函數的文檔字符串時採用的格式約定
每一個模塊也都應包含一個文檔字符串,對其中的類可用於作什麼進行描述
在類中,用一個空行來分隔方法
在模塊中,用兩個空行來分隔類
須要同時導入標準庫中的模塊和你編寫的模塊時,先編寫導入標準庫模塊中的import語句,再添加一個空行,而後編寫導入你本身編寫的模塊的import語句,這樣在包含多條import語句的程序中,這種作法讓人更容易明白程序使用的各個模塊都來自何方