寫Python需要養(yǎng)成的9個編程好習(xí)慣

以寫Python代碼為例,有以下9個編程好習(xí)慣人灼。

1. 提前設(shè)計(jì)

寫代碼和寫作文一樣,需要有大綱顾翼,不然很容易變成"屎山"投放。

思考業(yè)務(wù)邏輯和代碼流程,是動手前的準(zhǔn)備工作适贸,這上面可以花一半以上時間灸芳。

一些程序員洋洋灑灑寫了幾萬行,刪刪改改拜姿,bug很多烙样,誤以為自己很忙。這都是思考不足的結(jié)果蕊肥,導(dǎo)致時效很低谒获。

提前設(shè)計(jì)也有方法可循。

比如通過draw.io壁却、xwind等工具畫流程圖究反,想好每個模塊實(shí)現(xiàn)什么功能,然后寫偽代碼提煉核心邏輯儒洛,把每一個測試節(jié)點(diǎn)安排好。

2. 代碼注釋

代碼注釋相當(dāng)于產(chǎn)品說明書狼速,太重要了琅锻。

代碼注釋既是給自己看的,更是給別人看的向胡。因?yàn)榇a需要維護(hù)恼蓬。

如果你的繼任者沒法理解你寫的東西,那大概率是代碼寫的太爛了僵芹,或者注釋寫的太爛了处硬。

寫代碼注釋需要注意以下幾點(diǎn)原則:

  • 幫助別人理解你寫代碼的意圖,而不是重復(fù)這段代碼干了什么

  • 文字表述要簡潔清晰拇派,如非必要荷辕,勿增實(shí)體

  • 對實(shí)現(xiàn)代碼塊進(jìn)行注釋凿跳,而不是單行代碼

  • 對各種主要的數(shù)據(jù)結(jié)構(gòu)、輸出的函數(shù)疮方、多個函數(shù)公用的變量進(jìn)行詳細(xì)地注釋

Python代碼注釋規(guī)范:

Python使用文檔字符串來注釋控嗜,用三重雙引號""" """

文檔字符串是包, 模塊, 類或函數(shù)里的第一個語句. 這些字符串可以通過對象的doc成員被自動提取, 并且被pydoc所用

當(dāng)然如果你足夠優(yōu)秀,也可以讓代碼自己解釋自己骡显。

代碼的注釋不是越詳細(xì)越好疆栏。實(shí)際上好的代碼本身就是注釋,我們要盡量規(guī)范和美化自己的代碼來減少不必要的注釋惫谤。若編程語言足夠有表達(dá)力壁顶,就不需要注釋,盡量通過代碼來闡述溜歪。

3. 規(guī)范命名

命名是程序員最頭疼的一件事若专,很多代碼就是命名不規(guī)范導(dǎo)致閱讀性極差。

之前有過一個調(diào)查問卷痹愚,評選“程序員最頭疼的事情”富岳,命名問題赫然名列第一,占比達(dá)到49%

變量名拯腮、函數(shù)名窖式、類名等名稱需要遵循”所見即所得“的原則,就是名稱要能代表該變量动壤、函數(shù)萝喘、類的含義,讓人一目了然琼懊。

要想代碼足夠有表達(dá)力阁簸,良好且一致性的命名規(guī)范是必不可少的。

Python命名規(guī)范需要注意以下幾點(diǎn):

  • 模塊命名

(1)模塊推薦使用小寫命名哼丈,

(2)除非有很多字母启妹,盡量不要用下劃線

因?yàn)楹芏嗄K文件存與模塊名稱一致的類,模塊采用小寫醉旦,類采用首字母大寫饶米,這樣就能區(qū)分開模塊和類。

  • 類命名

(1)類名使用駝峰(CamelCase)命名風(fēng)格车胡,首字母大寫檬输;

(2)私有類可用一個下劃線開頭。

  • 函數(shù)命名

(1)函數(shù)名一律小寫匈棘,如有多個單詞丧慈,用下劃線隔開

(2)類內(nèi)部函數(shù)命名,用單下劃線(_)開頭(該函數(shù)可被繼承訪問)

  • 變量命令

(1)變量名推薦小寫主卫,如有多個單詞逃默,用下劃線隔開

(2)類內(nèi)部變量命名鹃愤,用單下劃線(_)開頭(該變量可被繼承訪問)

(3)類內(nèi)私有變量命名,用雙下劃線(__)開頭(該變量不可被繼承訪問)

  • 常量

常量名所有字母大寫笑旺,由下劃線連接各個單詞如MAX_OVERFLOW昼浦,TOTAL

  • 文件名

全小寫,可使用下劃線

4. 保持代碼美觀

Python強(qiáng)制縮進(jìn),所以代碼整潔度上有保障筒主,但我們也要注意細(xì)節(jié)关噪。

《代碼整潔之道》里面說,整潔的代碼是只做好一件事乌妙,這里尤其指函數(shù)使兔。

Python之禪可以很好地解釋什么是美觀地代碼。

優(yōu)美勝于丑陋(Python 以編寫優(yōu)美的代碼為目標(biāo))
明了勝于晦澀(優(yōu)美的代碼應(yīng)當(dāng)是明了的藤韵,命名規(guī)范虐沥,風(fēng)格相似)
簡潔勝于復(fù)雜(優(yōu)美的代碼應(yīng)當(dāng)是簡潔的,不要有復(fù)雜的內(nèi)部實(shí)現(xiàn))
復(fù)雜勝于凌亂(如果復(fù)雜不可避免泽艘,那代碼間也不能有難懂的關(guān)系欲险,要保持接口簡潔)
扁平勝于嵌套(優(yōu)美的代碼應(yīng)當(dāng)是扁平的,不能有太多的嵌套)
間隔勝于緊湊(優(yōu)美的代碼有適當(dāng)?shù)拈g隔匹涮,不要奢望一行代碼解決問題)
可讀性很重要(優(yōu)美的代碼是可讀的) 即便假借特例的實(shí)用性之名天试,也不可違背這些規(guī)則(這些規(guī)則至高無上)
不要包容所有錯誤,除非你確定需要這樣做(精準(zhǔn)地捕獲異常然低,不寫 except:pass 風(fēng)格的代碼)
當(dāng)存在多種可能喜每,不要嘗試去猜測 而是盡量找一種,最好是唯一一種明顯的解決方案(如果不確定雳攘,就用窮舉法) 雖然這并不容易带兜,因?yàn)槟悴皇?Python 之父(這里的 Dutch 是指 Guido )
做也許好過不做,但不假思索就動手還不如不做(動手之前要細(xì)思量)
如果你無法向人描述你的方案吨灭,那肯定不是一個好方案刚照;反之亦然(方案測評標(biāo)準(zhǔn)) 命名空間是一種絕妙的理念,我們應(yīng)當(dāng)多加利用(倡導(dǎo)與號召)

5. 完善的README

如果你使用過github喧兄,一定對README不陌生无畔,它相當(dāng)于一份項(xiàng)目說明書,幫助你理解該項(xiàng)目繁莹。

README作用主要有告訴人們?yōu)槭裁磻?yīng)該使用你的項(xiàng)目,以及如何安裝和使用特幔,一份標(biāo)準(zhǔn)化的README可以簡化它的創(chuàng)建和維護(hù)咨演,所以README值得你花時間去創(chuàng)建。

寫好 README 之后蚯斯,隨著項(xiàng)目的演進(jìn)及時更新它薄风,不會花太多時間饵较,但能讓你隨時都對項(xiàng)目有個整體的把握。絕對值得一試遭赂。

6. 模塊化

模塊化就是將繁雜冗長的代碼按照一定的規(guī)則規(guī)范分成多個塊(可以是面向?qū)ο蟮姆绞剑┗蛘呶募撸缓笤龠M(jìn)行組合實(shí)現(xiàn)想要的功能和結(jié)果。

模塊化可以在多個項(xiàng)目里復(fù)用代碼撇他,而不需要重新寫茄猫,就像造車模塊化一樣,底盤一樣困肩、電氣系統(tǒng)一樣划纽,只要改改外觀、內(nèi)飾锌畸,就可以造多個車型勇劣。

Python提供了強(qiáng)大的模塊支持,主要體現(xiàn)在潭枣,不僅 Python 標(biāo)準(zhǔn)庫中包含了大量的模塊(稱為標(biāo)準(zhǔn)模塊)比默,還有大量的第三方模塊,開發(fā)者自己也可以開發(fā)自定義模塊盆犁。通過這些強(qiáng)大的模塊可以極大地提高開發(fā)者的開發(fā)效率命咐。

7. 版本控制

隨著參與項(xiàng)目的人不斷增加,或因一時的大意造成了巨大的錯誤蚣抗,并需要回到以前的版本〕薨伲現(xiàn)在如果您的錯誤涉及到多個代碼文件,其中有些文件被修改了多天甚至幾個月前的翰铡。版本控制系統(tǒng)尤為重要钝域。

在幾個版本控制軟件中,Git是最受歡迎的锭魔,有大量的在線幫助文檔例证。使用Git,您可以根據(jù)需要保留盡可能多的修訂版本迷捧,分支出一些代碼實(shí)驗(yàn)的文件织咧,跟蹤上次更改的代碼部分,并隨時返回到他們漠秋。

8. 注意備份

備份不用多說了笙蒙,防止突發(fā)情況,這個很重要庆锦!

9. 多看官方文檔

不管用什么語言編程捅位,官方文檔永遠(yuǎn)是學(xué)習(xí)最好的選擇,最新最詳細(xì)的代碼說明都在官方文檔里。

Python也是這樣艇搀,雖然市場上的教程多如牛毛尿扯,但官方文檔必須要看的。

現(xiàn)在既有英文也有中文版焰雕,非常方便衷笋。

https://docs.python.org/zh-cn/3/

注:文中部分內(nèi)容來源網(wǎng)絡(luò)

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末听想,一起剝皮案震驚了整個濱河市疲扎,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌等恐,老刑警劉巖档插,帶你破解...
    沈念sama閱讀 211,290評論 6 491
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件慢蜓,死亡現(xiàn)場離奇詭異,居然都是意外死亡郭膛,警方通過查閱死者的電腦和手機(jī)晨抡,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,107評論 2 385
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來则剃,“玉大人耘柱,你說我怎么就攤上這事」飨郑” “怎么了调煎?”我有些...
    開封第一講書人閱讀 156,872評論 0 347
  • 文/不壞的土叔 我叫張陵,是天一觀的道長己肮。 經(jīng)常有香客問我士袄,道長,這世上最難降的妖魔是什么谎僻? 我笑而不...
    開封第一講書人閱讀 56,415評論 1 283
  • 正文 為了忘掉前任娄柳,我火速辦了婚禮,結(jié)果婚禮上艘绍,老公的妹妹穿的比我還像新娘赤拒。我一直安慰自己,他們只是感情好诱鞠,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,453評論 6 385
  • 文/花漫 我一把揭開白布挎挖。 她就那樣靜靜地躺著,像睡著了一般航夺。 火紅的嫁衣襯著肌膚如雪蕉朵。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,784評論 1 290
  • 那天阳掐,我揣著相機(jī)與錄音始衅,去河邊找鬼堪伍。 笑死,一個胖子當(dāng)著我的面吹牛觅闽,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播涮俄,決...
    沈念sama閱讀 38,927評論 3 406
  • 文/蒼蘭香墨 我猛地睜開眼蛉拙,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了彻亲?” 一聲冷哼從身側(cè)響起孕锄,我...
    開封第一講書人閱讀 37,691評論 0 266
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎苞尝,沒想到半個月后畸肆,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 44,137評論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡宙址,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,472評論 2 326
  • 正文 我和宋清朗相戀三年轴脐,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片抡砂。...
    茶點(diǎn)故事閱讀 38,622評論 1 340
  • 序言:一個原本活蹦亂跳的男人離奇死亡大咱,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出注益,到底是詐尸還是另有隱情碴巾,我是刑警寧澤,帶...
    沈念sama閱讀 34,289評論 4 329
  • 正文 年R本政府宣布丑搔,位于F島的核電站厦瓢,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏啤月。R本人自食惡果不足惜煮仇,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,887評論 3 312
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望顽冶。 院中可真熱鬧欺抗,春花似錦、人聲如沸强重。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,741評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽间景。三九已至佃声,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間倘要,已是汗流浹背圾亏。 一陣腳步聲響...
    開封第一講書人閱讀 31,977評論 1 265
  • 我被黑心中介騙來泰國打工十拣, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人志鹃。 一個月前我還...
    沈念sama閱讀 46,316評論 2 360
  • 正文 我出身青樓夭问,卻偏偏與公主長得像,于是被迫代替她去往敵國和親曹铃。 傳聞我的和親對象是個殘疾皇子缰趋,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,490評論 2 348

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