Python編碼規(guī)范之PEP8指南【Python編程約定】

　　程序的編碼風(fēng)格是一個(gè)人編寫(xiě)程序時(shí)表現(xiàn)出來(lái)的特點(diǎn)、習(xí)慣邏輯思路等。我們?cè)诔绦蜷_(kāi)發(fā)時(shí)要重視其編寫(xiě)規(guī)范，程序不僅應(yīng)該能夠在機(jī)器上正確執(zhí)行，還應(yīng)便于調(diào)試、維護(hù)及閱讀。PEP8是一份關(guān)于Python編碼規(guī)范指南，遵守該規(guī)范能夠幫助Python開(kāi)發(fā)者編寫(xiě)出優(yōu)雅的代碼，提高代碼可讀性。下面舉例說(shuō)明一些編程規(guī)范。

　　1.代碼布局

　　(1)縮講。標(biāo)準(zhǔn)Python風(fēng)格中每個(gè)縮進(jìn)級(jí)別使用4個(gè)空格，不推薦使用Tab，禁止混用空格與Tab。

　　(2)行的最大長(zhǎng)度。每行最大長(zhǎng)度79，換行可以使用反斜杠，但建議使用圓括號(hào)。

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

　　2.空格的使用

　　(1)右括號(hào)前不要加空格。

　　(2)逗號(hào)、冒號(hào)、分號(hào)前不要加空格。

　　(3)函數(shù)的左括號(hào)前不要加空格，如fum(l)。

　　(4)序列的左括號(hào)前不要加空格，如list[2]。

　　(5)操作符左右各加一個(gè)空格，如a+b=c。

　　(6)不要將多條語(yǔ)句寫(xiě)在同一行。

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

　　3.代碼注釋

　　(1)塊注釋。塊注釋跟隨被注釋的代碼，縮進(jìn)至與代碼相同的級(jí)別。塊注釋使用“#”開(kāi)頭。

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

　　(3)文檔字符串。文檔字符串指的是為所有公共模塊、函數(shù)、類(lèi)以及方法編寫(xiě)的文檔說(shuō)明。文檔字符串使用三引號(hào)包裹。

　　4.命名規(guī)范

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

　　(2)模塊名、包名應(yīng)簡(jiǎn)短且全為小寫(xiě)。

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

　　(4)類(lèi)名首字母一般使用大寫(xiě)。

　　(5)常量通常采用全大寫(xiě)命名。