Python程序編寫規(guī)范【編程約定】

程序的編碼風(fēng)格是一個人編寫程序時表現(xiàn)出來的特點、習(xí)慣邏輯思路等。我們在程序開發(fā)時要重視其編寫規(guī)范，程序不僅應(yīng)該能夠在機器上正確執(zhí)行，還應(yīng)便于調(diào)試、維護及閱讀。

PEP8是一份關(guān)于Python編碼規(guī)范指南，遵守該規(guī)范能夠幫助Python開發(fā)者編寫出優(yōu)雅的代碼，提高代碼可讀性。下面舉例說明一些編程規(guī)范。

1.代碼布局

（1）縮進。標(biāo)準Python風(fēng)格中每個縮進級別使用4個空格，不推薦使用Tab，禁止混用空格與Tab。

（2）行的最大長度。每行最大長度79，換行可以使用反斜杠，但建議使用圓括號。

（3）空白行。頂層函數(shù)和定義的類之間空兩行，類中的方法定義之間空一行；函數(shù)內(nèi)邏輯無關(guān)的代碼段之間空一行，其他地方盡量不要空行。

2.空格的使用

（1）右括號前不要加空格。

（2）逗號、冒號、分號前不要加空格。

（3）函數(shù)的左括號前不要加空格，如fun（1）。

（4）序列的左括號前不要加空格，如list[2]。

（5）操作符左右各加一個空格，如a+b=c。

（6）不要將多條語句寫在同一行。

（7）if、for、while語句中，即使執(zhí)行語句只有一句，也必須另起一行。

3.代碼注釋

（1）塊注釋。塊注釋跟隨被注釋的代碼，縮進至與代碼相同的級別。塊注釋使用“#”開頭。

（2）行內(nèi)注釋。行內(nèi)注釋是與代碼語句同行的注釋。行內(nèi)注釋與代碼至少由兩個空格分隔，注釋以“#”開頭。

（3）文檔字符串。文檔字符串指的是為所有公共模塊、函數(shù)、類以及方法編寫的文檔說明。文檔字符串使用三引號包裹。

4.命名規(guī)范

（1）不要使用字母“I”（L的小寫）、“0”（大寫0）、“I”（大寫I）作為單字符變量名。

（2）模塊名、包名應(yīng)簡短且全為小寫。

（3）函數(shù)名應(yīng)該小寫，如果想提高可讀性，可以用下畫線分隔小寫單詞。

（4）類名首字母一般使用大寫。

（5）常量通常采用全大寫命名。