名稱不要縮寫!!!
成都創(chuàng)新互聯(lián)公司專業(yè)為企業(yè)提供洛隆網(wǎng)站建設、洛隆做網(wǎng)站、洛隆網(wǎng)站設計、洛隆網(wǎng)站制作等企業(yè)網(wǎng)站建設、網(wǎng)頁設計與制作、洛隆企業(yè)網(wǎng)站模板建站服務,十多年洛隆做網(wǎng)站經(jīng)驗,不只是建網(wǎng)站,更提供有價值的思路和整體網(wǎng)絡服務。
名稱不要縮寫?。?!
名稱不要縮寫?。。?/p>
包命名:小寫,下劃線_連接單詞
模塊命名:小寫,下劃線_連接單詞
類命名:雙駝峰,MyClass
函數(shù)命名:小寫,下劃線_連接單詞
全局變量:每個字母大寫
注釋很重要,要注明函數(shù)或類的功能,參數(shù)的數(shù)據(jù)類型、含義等。
注釋模板:
注釋的作用:
Python有句話是do not repeat yourself,即不要做重復的事,因此出現(xiàn)了類或函數(shù)的封裝和繼承,基于此可提高代碼的重復利用性。
模塊名:
小寫字母,單詞之間用_分割
ad_stats.py
包名:
和模塊名一樣
類名:
單詞首字母大寫
AdStats
ConfigUtil
全局變量名(類變量,在java中相當于static變量):
大寫字母,單詞之間用_分割
NUMBER
COLOR_WRITE
普通變量:
小寫字母,單詞之間用_分割
this_is_a_var
實例變量:
以_開頭,其他和普通變量一樣
_price
_instance_var
私有實例變量(外部訪問會報錯):
以__開頭(2個下劃線),其他和普通變量一樣
__private_var
專有變量:
__開頭,__結尾,一般為python的自有變量,不要以這種方式命名
__doc__
__class__
普通函數(shù):
和普通變量一樣:
get_name()
count_number()
ad_stat()
私有函數(shù)(外部訪問會報錯):
以__開頭(2個下劃線),其他和普通函數(shù)一樣
__get_name()
————————————————————————————————————————————————————————————————————
文件名
全小寫,可使用下劃線
包
應該是簡短的、小寫的名字。如果下劃線可以改善可讀性可以加入。如mypackage。
模塊
與包的規(guī)范同。如mymodule。
類
總是使用首字母大寫單詞串。如MyClass。內(nèi)部類可以使用額外的前導下劃線。
函數(shù)方法
函數(shù)名應該為小寫,可以用下劃線風格單詞以增加可讀性。如:myfunction,my_example_function。
*注意*:混合大小寫僅被允許用于這種風格已經(jīng)占據(jù)優(yōu)勢的時候,以便保持向后兼容。
函數(shù)和方法的參數(shù)
總使用“self”作為實例方法的第一個參數(shù)??偸褂谩癱ls”作為類方法的第一個參數(shù)。
如果一個函數(shù)的參數(shù)名稱和保留的關鍵字沖突,通常使用一個后綴下劃線好于使用縮寫或奇怪的拼寫。
全局變量
對于from M import *導入語句,如果想阻止導入模塊內(nèi)的全局變量可以使用舊有的規(guī)范,在全局變量上加一個前導的下劃線。
*注意*:應避免使用全局變量
變量
變量名全部小寫,由下劃線連接各個單詞。如color = WHITE,this_is_a_variable = 1
*注意*:
1.不論是類成員變量還是全局變量,均不使用 m 或 g 前綴。
2.私有類成員使用單一下劃線前綴標識,多定義公開成員,少定義私有成員。
3.變量名不應帶有類型信息,因為Python是動態(tài)類型語言。如 iValue、names_list、dict_obj 等都是不好的命名。
常量
常量名所有字母大寫,由下劃線連接各個單詞如MAX_OVERFLOW,TOTAL。
異常
以“Error”作為后綴。
縮寫
命名應當盡量使用全拼寫的單詞,縮寫的情況有如下兩種:
1.常用的縮寫,如XML、ID等,在命名時也應只大寫首字母,如XmlParser。
2.命名中含有長單詞,對某個單詞進行縮寫。這時應使用約定成俗的縮寫方式。
例如:
function 縮寫為 fn
text 縮寫為 txt
object 縮寫為 obj
count 縮寫為 cnt
number 縮寫為 num,等。
前導后綴下劃線
一個前導下劃線:表示非公有。
一個后綴下劃線:避免關鍵字沖突。
兩個前導下劃線:當命名一個類屬性引起名稱沖突時使用。
兩個前導和后綴下劃線:“魔”(有特殊用途)對象或者屬性,例如__init__或者__file__。絕對不要創(chuàng)造這樣的名字,而只是使用它們。
*注意*:關于下劃線的使用存在一些爭議。
Python 用下劃線作為變量前綴和后綴指定特殊變量。
_xxx 不能用'from module import *'導入
__xxx__ 系統(tǒng)定義名字
__xxx 類中的私有變量名
核心風格:避免用下劃線作為變量名的開始。
因為下劃線對解釋器有特殊的意義,而且是內(nèi)建標識符所使用的符號,我們建議程序員避免用下劃線作為變量名的開始。一般來講,變量名_xxx被看作是“私有的”,在模塊或類外不可以使用。當變量是私有的時候,用_xxx 來表示變量是很好的習慣。因為變量名__xxx__對Python 來說刑厥夂澹雜諂脹ǖ謀淞坑Φ北苊庹庵置綹瘛?br
"單下劃線" 開始的成員變量叫做保護變量,意思是只有類對象和子類對象自己能訪問到這些變量;
"雙下劃線" 開始的是私有成員,意思是只有類對象自己能訪問,連子類對象也不能訪問到這個數(shù)據(jù)。
以單下劃線開頭(_foo)的代表不能直接訪問的類屬性,需通過類提供的接口進行訪問,不能用“from xxx import *”而導入;以雙下劃線開頭的(__foo)代表類的私有成員;以雙下劃線開頭和結尾的(__foo__)代表python里特殊方法專用的標識,如 __init__()代表類的構造函數(shù)。
特定命名方式
主要是指 __xxx__ 形式的系統(tǒng)保留字命名法。項目中也可以使用這種命名,它的意義在于這種形式的變量是只讀的,這種形式的類成員函數(shù)盡量不要重載。如
class Base(object):
def __init__(self, id, parent = None):
self.__id__ = id
self.__parent__ = parent
def __message__(self, msgid):
# …略
其中 __id__、__parent__ 和 __message__ 都采用了系統(tǒng)保留字命名法。
Python 命名一般來說有一下不成文的規(guī)則 :
模塊名一般使用全部小寫 如 myphone
類名第一個字母大寫,如果有多個單詞,每一個單詞的第一個字母大寫如 : MyPhone
函數(shù)名 : 小寫, 如果有多個單詞用下劃線隔開 如 my_phone
常量名字一般全大寫 : MYPHONE
編碼格式聲明
通常,編碼格式聲明是必需的。如果 python 源碼文件沒有聲明編碼格式,python 解釋器會默認使用 ASCII 編碼,一旦源碼文件包含非ASCII編碼的字符,python 解釋器就會報錯。以 UTF-8 為例,以下兩種編碼格式聲明都是合乎規(guī)則的。
縮進
統(tǒng)一使用 4 個空格進行縮進。絕對不要用tab, 也不要tab和空格混用。對于行連接的情況,我一般使用4空格的懸掛式縮進。例如:
引號
自然語言使用雙引號
機器標識使用單引號
正則表達式使用雙引號
空行
編碼格式聲明、模塊導入、常量和全局變量聲明、頂級定義和執(zhí)行代碼之間空兩行
頂級定義之間空兩行,方法定義之間空一行
在函數(shù)或方法內(nèi)部,可以在必要的地方空一行以增強節(jié)奏感,但應避免連續(xù)空行
導入模塊
導入總應該放在文件頂部,位于模塊注釋和文檔字符串之后,模塊全局變量和常量之前。導入應該按照從最通用到最不通用的順序分組,分組之間空一行
標準庫導入
第三方庫導入
應用程序指定導入
命名規(guī)范
模塊盡量使用小寫命名,首字母保持小寫,盡量不要用下劃線
類名使用駝峰(CamelCase)命名風格,首字母大寫,私有類可用一個下劃線開頭
函數(shù)名一律小寫,如有多個單詞,用下劃線隔開
私有函數(shù)可用一個下劃線開頭
變量名盡量小寫, 如有多個單詞,用下劃線隔開
常量采用全大寫,如有多個單詞,使用下劃線隔開