三、python編碼規(guī)范

python編碼規(guī)范

官方網(wǎng)址：https://www.python.org/dev/peps/pep-0008/

官方介紹如下：
本文檔給出了Python主要發(fā)行版中包含標準庫的Python代碼的編碼約定。請參閱有關Python[1]的C實現(xiàn)中的C代碼的描述樣式指南的配套信息PEP。

本文檔和PEP 257(文檔字符串約定)改編自Guido的原始Python風格指南文章，并添加了一些Barry的風格指南[2]。

這種風格指南隨著時間的推移而發(fā)展，因為語言本身的變化確定了更多的約定，而過去的約定也變得過時了。

許多項目都有自己的編碼風格指南。在發(fā)生任何沖突時，此類特定于項目的指南應優(yōu)先用于該項目。

那么，本文是簡單介紹PEP 8和PEP 257介紹。

pep8規(guī)范

格式化pep8快捷鍵：ctrl+alt+L

1、縮進

#每一級縮進4個空格（pycharm里是一個tab）
#對齊縮進：參數(shù)對齊左邊括號
#懸掛縮進：4個空格，對齊參數(shù)
#層級縮進：8個空格，對齊參數(shù)

2、行的最大長度

#單行代碼字符數(shù)不要超過79個字符
#通過“”來隱式換行
#注釋最大72字符

with open(r"D:360downloadswpcachep3.qhimg.combdr__85file01") as file01, 
		open(r"D:360downloadswpcachep3.qhimg.combdr__85file02") as file02:
	content=file01.read()
	file02.write(content)

3、空行

#頂層函數(shù)和類定義，前后用兩個空行隔開
#類里的方法定義用一個空行隔開

4、注釋

#寫代碼前先寫注釋，修改代碼也應該先修改注釋

def func(n1, n2, n3 ):
	"""自定義函數(shù)
	:n1:參數(shù)1
	:n1:參數(shù)2
	:n1:參數(shù)3
	:return:返回結果
	"""

5、命名約定
#禁止使用I（小寫的L）、O（大寫的o）、l（大寫的i）

6、字符串引號

7、模塊和包導入規(guī)范

#模塊導入順序：官方庫-》第三方庫-》自定義模塊
#__all__變量：限制導入可以使用這種方法

pep257規(guī)范

官方文檔：https://www.python.org/dev/peps/pep-0257/

1、工程結構化
#項目名稱，即項目文件夾