python命名規(guī)范

平常寫(xiě)代碼雜亂無(wú)章的珠叔,自己看上去沒(méi)太大影響废赞,但是當(dāng)別人來(lái)讀你的代碼的時(shí)候就苦不堪言湾戳,自己再去整理的時(shí)候很多問(wèn)題也難以發(fā)現(xiàn)闷板,代碼過(guò)程中也是東一塊西一塊像是拼接成似的,所以這個(gè)時(shí)候規(guī)范化的代碼就顯得格外重要院塞,小編在實(shí)驗(yàn)室的練習(xí)過(guò)程中就發(fā)現(xiàn),與學(xué)校合作的公司項(xiàng)目要求都是在項(xiàng)目命名格外注重的性昭。

  • 項(xiàng)目名——首字母大寫(xiě)拦止、其余單詞小寫(xiě),多單詞組合則用下劃線分割
  • 包名、模塊名——全用小寫(xiě)字母
  • 類名——首字母大寫(xiě)汹族、其他字母小寫(xiě)萧求,多單詞采用駝峰
  • 方法——小寫(xiě)單詞
  • 函數(shù)——若函數(shù)的參數(shù)名與保留關(guān)鍵字沖突,則在參數(shù)后加一個(gè)下劃線顶瞒,比拼音好太多
  • 全局變量——采用全大寫(xiě)夸政,多單詞用下劃線分割

注意:

1.不論是類成員變量還是全局變量,均不使用 m 或 g 前綴榴徐。
2.私有類成員使用單一下劃線前綴標(biāo)識(shí)守问,多定義公開(kāi)成員,少定義私有成員坑资。
3.變量名不應(yīng)帶有類型信息耗帕,因?yàn)镻ython是動(dòng)態(tài)類型語(yǔ)言。如 iValue袱贮、names_list仿便、dict_obj 等都是不好的命名。
4.開(kāi)頭攒巍,結(jié)尾嗽仪,一般為python的自有變量,不要以這種方式命名
5.以__開(kāi)頭(2個(gè)下劃線)柒莉,是私有實(shí)例變量(外部不嫩直接訪問(wèn))闻坚,依照情況進(jìn)行命名

縮寫(xiě)

命名應(yīng)當(dāng)盡量使用全拼寫(xiě)的單詞,縮寫(xiě)的情況有如下兩種:

  1. 常用的縮寫(xiě)常柄,如XML鲤氢、ID等,在命名時(shí)也應(yīng)只大寫(xiě)首字母西潘,如XmlParser卷玉。
  2. 命名中含有長(zhǎng)單詞,對(duì)某個(gè)單詞進(jìn)行縮寫(xiě)喷市。這時(shí)應(yīng)使用約定成俗的縮寫(xiě)方式相种。

例如:

function 縮寫(xiě)為 fn
text 縮寫(xiě)為 txt
object 縮寫(xiě)為 obj
count 縮寫(xiě)為 cnt
number 縮寫(xiě)為 num,等品姓。

前導(dǎo)后綴下劃線

一個(gè)前導(dǎo)下劃線:表示非公有寝并。
一個(gè)后綴下劃線:避免關(guān)鍵字沖突。
兩個(gè)前導(dǎo)下劃線:當(dāng)命名一個(gè)類屬性引起名稱沖突時(shí)使用腹备。
兩個(gè)前導(dǎo)和后綴下劃線:(有特殊用圖)的對(duì)象或者屬性衬潦,例如init或者file。絕對(duì)不要?jiǎng)?chuàng)造這樣的名字植酥,而只是使用它們镀岛。
注意——關(guān)于下劃線的使用存在一些爭(zhēng)議弦牡。

命名注意:

不要使用小寫(xiě)字母'l'(el),大寫(xiě)字母'O'(oh),或者小寫(xiě)'i'作為單獨(dú)變量名稱。因?yàn)橐恍┳煮w中漂羊,上訴字母和數(shù)字很難區(qū)分(比如:O和0驾锰,l和1)。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末走越,一起剝皮案震驚了整個(gè)濱河市椭豫,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌旨指,老刑警劉巖赏酥,帶你破解...
    沈念sama閱讀 219,539評(píng)論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異淤毛,居然都是意外死亡今缚,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,594評(píng)論 3 396
  • 文/潘曉璐 我一進(jìn)店門低淡,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)姓言,“玉大人,你說(shuō)我怎么就攤上這事蔗蹋『渭裕” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 165,871評(píng)論 0 356
  • 文/不壞的土叔 我叫張陵猪杭,是天一觀的道長(zhǎng)餐塘。 經(jīng)常有香客問(wèn)我,道長(zhǎng)皂吮,這世上最難降的妖魔是什么戒傻? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,963評(píng)論 1 295
  • 正文 為了忘掉前任,我火速辦了婚禮蜂筹,結(jié)果婚禮上需纳,老公的妹妹穿的比我還像新娘。我一直安慰自己艺挪,他們只是感情好不翩,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,984評(píng)論 6 393
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著麻裳,像睡著了一般口蝠。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上津坑,一...
    開(kāi)封第一講書(shū)人閱讀 51,763評(píng)論 1 307
  • 那天妙蔗,我揣著相機(jī)與錄音,去河邊找鬼疆瑰。 笑死眉反,一個(gè)胖子當(dāng)著我的面吹牛狞谱,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播禁漓,決...
    沈念sama閱讀 40,468評(píng)論 3 420
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼孵睬!你這毒婦竟也來(lái)了播歼?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書(shū)人閱讀 39,357評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤掰读,失蹤者是張志新(化名)和其女友劉穎秘狞,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體蹈集,經(jīng)...
    沈念sama閱讀 45,850評(píng)論 1 317
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡烁试,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,002評(píng)論 3 338
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了拢肆。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片减响。...
    茶點(diǎn)故事閱讀 40,144評(píng)論 1 351
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖郭怪,靈堂內(nèi)的尸體忽然破棺而出支示,到底是詐尸還是另有隱情,我是刑警寧澤鄙才,帶...
    沈念sama閱讀 35,823評(píng)論 5 346
  • 正文 年R本政府宣布颂鸿,位于F島的核電站,受9級(jí)特大地震影響攒庵,放射性物質(zhì)發(fā)生泄漏嘴纺。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,483評(píng)論 3 331
  • 文/蒙蒙 一浓冒、第九天 我趴在偏房一處隱蔽的房頂上張望栽渴。 院中可真熱鬧,春花似錦裆蒸、人聲如沸熔萧。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 32,026評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)佛致。三九已至,卻和暖如春辙谜,著一層夾襖步出監(jiān)牢的瞬間俺榆,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 33,150評(píng)論 1 272
  • 我被黑心中介騙來(lái)泰國(guó)打工装哆, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留罐脊,地道東北人定嗓。 一個(gè)月前我還...
    沈念sama閱讀 48,415評(píng)論 3 373
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像萍桌,于是被迫代替她去往敵國(guó)和親宵溅。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,092評(píng)論 2 355

推薦閱讀更多精彩內(nèi)容