人生苦短,你用python嗎?
化學專業的小凱,卻喜歡上了計算機語言,業餘時間入門了python,從此無法自拔,話不多說,接下來與大家分享我的學習筆記。(Python 編碼規範)
“無規矩不成方圓”
一.命名規範
程式代碼中遍地都是辨別符,是以有一個一緻的并且符合規範的名字很重要。
1.包名:全部是小寫字母,中間可以由點号分開,不推薦使用下劃線。
2.子產品名:全部是小寫字母,如果是多個單詞構成,可以用下劃線隔開,xiaokai_nihao
3.類名:駝峰法命名 ,XiaokaiNihao
4.異常名:異常名。異常屬于類,命名同類命名,但應該使用Error作為字尾。如
FileNotFoundError。
5.變量名:全部小寫字母,如果是多個單詞構成,可以用下劃線隔開。如果變量應用于子產品或函數内部,則變量名可以單下劃線開頭;如果變量類内部私有使用變量名可以雙下劃線開頭。不要命名雙下劃線開頭和結尾的變量,這是Python保留的。另外,避免使用小寫L、大寫O和大寫I作為變量名。
6.函數名和方法名:命名同變量命名。如balance_account、_push_cm_exit
二.注釋規範
1.檔案注釋:采用多行注釋,在每一個檔案開頭添加注釋。檔案注釋通常包括版本資訊、檔案名、所在模版、作者資訊等資訊。
# # 版權所有 2015 xxxxxxxxx有限公司# 許可資訊檢視xxxxx.txt檔案# 描述:# 實作日期基本功能# 曆史版本:# 2015-7-22: # 2015-8-20: # 2015-8-22: #
上面隻是例子,具體要根據實際情況來進行注釋。
2.文檔注釋:文檔注釋推薦使用一對三重雙引号(""")包裹起來,文檔注釋應該在被注釋的子產品,函數,類和方法内部的第一條語句。
如果文檔注釋在一行能夠完成,那麼結束的引号也要在這一行;如果文檔很長,第一行後面是一個空行,然後在進行注釋,開頭要與第一個引号對齊,結束的引号要單獨在一行,并且和第一個引号對齊。
3.代碼注釋:代碼注釋放在一些關鍵的地方,友善閱讀代碼的人參考。代碼注釋要求與球的代碼有相同的縮進級别;尾端注釋,要求注釋的内容極短,而且代碼和注釋之間應該留最少兩個空格。
三.導入規範
導入語句的位置在子產品注釋和文檔注釋後面,子產品全局變量之前,而且每個導入語句隻能導入一個子產品。
import reimport structimport binascii
導入語句的順序是:标準庫→第三方庫→自己的子產品
四.代碼排版
1.空行
(1)import語句前後要留兩個空行
(2)函數聲明前面要留兩個空行
(3)類聲明前面要留兩個空行
(4)方法聲明之前要留一個空行
(5)兩個邏輯代碼塊之間要有一個空行
2.空格
(1)指派符号(=)前後各一個空格
(2)二進制運算符要使用空格和操作數分割
a += c + d
(3)括号内不能有空格(括号包括大中小括号)
(4)逗号、冒号、分号前面不能有空格,後面要跟一個空格
(5)參數清單、索引、切片的左括号前面不能有空格
dogs['key'] = list[index]
3.縮進
4個空格為縮進排版的一個縮進級别,代碼塊的内容相當于首行縮進一個級别
4.斷行
一行代碼最多有79個字元,文檔注釋和多行注釋一行最多72個字元,如果超過就要斷行。
(1)逗号後面斷開
(2)在運算符前斷開
(3)盡量不要使用續行符(),若有括号,可以在括号裡面斷行,這樣就可以不用續行符()。
規範沒必要去刻意的記,在逐漸的學習中,規範是融入代碼中的,随着敲代碼越來越多,自然而然的就掌握了編碼規範。
下一篇筆記分享資料類型
謝謝大家