以寫Python代碼為例，有以下9個編程好習慣。

1. 提前設計

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

思考業(yè)務邏輯和代碼流程，是動手前的準備工作，這上面可以花一半以上時間。

一些程序員洋洋灑灑寫了幾萬行，刪刪改改，bug很多，誤以為自己很忙。這都是思考不足的結果，導致時效很低。

提前設計也有方法可循。

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

2. 代碼注釋

代碼注釋相當于產品說明書，太重要了。

代碼注釋既是給自己看的，更是給別人看的。因為代碼需要維護。

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

寫代碼注釋需要注意以下幾點原則：

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

• 文字表述要簡潔清晰，如非必要，勿增實體

• 對實現(xiàn)代碼塊進行注釋，而不是單行代碼

• 對各種主要的數(shù)據(jù)結構、輸出的函數(shù)、多個函數(shù)公用的變量進行詳細地注釋

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

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

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

當然如果你足夠優(yōu)秀，也可以讓代碼自己解釋自己。

代碼的注釋不是越詳細越好。實際上好的代碼本身就是注釋，我們要盡量規(guī)范和美化自己的代碼來減少不必要的注釋。若編程語言足夠有表達力，就不需要注釋，盡量通過代碼來闡述。

3. 規(guī)范命名

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

之前有過一個調查問卷，評選“程序員最頭疼的事情”，命名問題赫然名列第一，占比達到49%

變量名、函數(shù)名、類名等名稱需要遵循”所見即所得“的原則，就是名稱要能代表該變量、函數(shù)、類的含義，讓人一目了然。

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

Python命名規(guī)范需要注意以下幾點：

• 模塊命名

（1）模塊推薦使用小寫命名，

（2）除非有很多字母，盡量不要用下劃線

因為很多模塊文件存與模塊名稱一致的類，模塊采用小寫，類采用首字母大寫，這樣就能區(qū)分開模塊和類。

• 類命名

（1）類名使用駝峰(CamelCase)命名風格，首字母大寫；

（2）私有類可用一個下劃線開頭。

• 函數(shù)命名

（1）函數(shù)名一律小寫，如有多個單詞，用下劃線隔開

（2）類內部函數(shù)命名，用單下劃線(_)開頭（該函數(shù)可被繼承訪問）

• 變量命令

（1）變量名推薦小寫，如有多個單詞，用下劃線隔開

（2）類內部變量命名，用單下劃線(_)開頭（該變量可被繼承訪問）

（3）類內私有變量命名，用雙下劃線(__)開頭（該變量不可被繼承訪問）

• 常量

常量名所有字母大寫，由下劃線連接各個單詞如MAX_OVERFLOW，TOTAL

• 文件名

全小寫,可使用下劃線

4. 保持代碼美觀

Python強制縮進，所以代碼整潔度上有保障，但我們也要注意細節(jié)。

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

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

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

5. 完善的README

如果你使用過github，一定對README不陌生，它相當于一份項目說明書，幫助你理解該項目。

README作用主要有告訴人們?yōu)槭裁磻撌褂媚愕捻椖浚约叭绾伟惭b和使用，一份標準化的README可以簡化它的創(chuàng)建和維護，所以README值得你花時間去創(chuàng)建。

寫好 README 之后，隨著項目的演進及時更新它，不會花太多時間，但能讓你隨時都對項目有個整體的把握。絕對值得一試。

6. 模塊化

模塊化就是將繁雜冗長的代碼按照一定的規(guī)則規(guī)范分成多個塊（可以是面向對象的方式）或者文件，然后再進行組合實現(xiàn)想要的功能和結果。

模塊化可以在多個項目里復用代碼，而不需要重新寫，就像造車模塊化一樣，底盤一樣、電氣系統(tǒng)一樣，只要改改外觀、內飾，就可以造多個車型。

Python提供了強大的模塊支持，主要體現(xiàn)在，不僅 Python 標準庫中包含了大量的模塊（稱為標準模塊），還有大量的第三方模塊，開發(fā)者自己也可以開發(fā)自定義模塊。通過這些強大的模塊可以極大地提高開發(fā)者的開發(fā)效率。

7. 版本控制

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

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

8. 注意備份

備份不用多說了，防止突發(fā)情況，這個很重要！

9. 多看官方文檔

不管用什么語言編程，官方文檔永遠是學習最好的選擇，最新最詳細的代碼說明都在官方文檔里。

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

現(xiàn)在既有英文也有中文版，非常方便。

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

注：文中部分內容來源網絡