首先談一下注釋:
注釋不止是為了自己以后看的更清楚,還是為了以后的開發人員所準備的,其實一段時間后,當需要對程序做一些修改或者是改正某個bug的時候,可能未來的我們自己都會忘記相關的細節,所以此時注釋顯得尤為重要。
每條注釋以井號(#)開始,一直到該行末尾結束,一直到該行末尾結束。我們可以在注釋中放任何東西,因為Python會完全無視他們的存在。為了寫好注釋,這里給出以后幾條規則:
(1)假設讀者的Python水平和你一樣(比如說,不要去解釋“什么是字符串”,也不要去解釋“什么是賦值語句”)
(2)不要去注釋那些毫無意義的事情。比如說:
count=count+1#addonetocount
(3)很多程序員會在代碼上寫上一些以“TODO”或者“FIXME”開始的注釋,目的就是為了提醒他們回來編寫或清理一些未完成的一些問題。
(4)如果你在編寫某段程序的時候需要使勁思考的話,應該編寫注釋,以后別人不會在這個地方絞盡腦汁。尤其要注意的是,如果你在開發程序的時候或者函數編寫的時候使用要點來描述,盡量寫的細致一點,在開發工作完成之后,還應該將原來的要點全部保留下倆直接做解釋。
(5)同樣,如果某個bug很難查明,或者其修改方案比較復雜,那么你就應該編寫一條注釋對其進行解釋。如果不這么做,那么今后其他復雜該部分的代碼的程序員就會可能認定他們沒有必要這么復雜并將其改為原來的樣子,從而將你的心血付諸東流。
(6)如果需要大量的注釋才能解釋清楚某段代碼的作用,那么就應該對這些代碼進行整理,比如,如果需要分別對一個函數的15個列表進行解釋,那么就應該將該函數拆分成更小的代碼塊,每隔分別只處理較小的幾個列表。
(7)過時的注釋還不如沒有注釋,因此修改某段代碼后,一定要檢查相關注釋,并對其做出適當的修改以保證其仍然能夠準確描述代碼的功能。
(8)注釋不是越多越好,弄得整篇代碼都是注釋,卻很少看到代碼,這樣就曲解了注釋的意思了。
所以說,一定要養成良好的注釋代碼的習慣,邊寫代碼邊注釋,及時的記錄下來你的思路,舉個例子,代碼是魚,注釋就是水,有了正確的注釋,魚才能更好的生存。還有就是多提高自己對代碼的解釋能力,用精煉的語言表達出代碼的核心價值所在,那么你寫的代碼就是成功的。
以上內容為大家介紹了Python編程規范的重要性,希望對大家有所幫助,如果想要了解更多Python相關知識,請關注IT培訓機構:千鋒教育。