1 注釋
介紹
在大多數編程語言當中，注釋都是一項非常有用的功能，我們開始撰寫的程式之中都只包含Python代碼，但是隨著程式越來越大、越來越復雜，就應在其中添加說明，對你解決問題的方法進行大致的闡述，注釋讓你能夠使用自然語言在程式當中添加說明，在Python中，注釋用井號（#）標識，井號后面的內容都會被Python解釋器忽略，如下所示：
# 向大家問好 print("Hello Python people!")
Python解釋器將忽略第一行，只執行第二行，
Hello Python people！
該撰寫什么樣的注釋
撰寫注釋的主要目的是闡述代碼要做什么，以及是如何做的，在開發專案期間，你對各個部分如何協同作業了如指掌，但是過了一段時間之后，有些細節你可能不記得了，當然，你總是可以通過研究代碼來確定各個部分的作業原理，但是通過撰寫注釋，以清晰的自然語言對解決方案進行概述，可以節省很多時間，
要成為專業程式員或與其他程式員合作，就必須撰寫有意義的注釋，當前，大多數軟體都是合作撰寫的，撰寫者可能是同一家公司的多名員工，也可能是眾多致力于同一個開源專案的人員，訓練有素的程式員都希望代碼中包含注釋，因此你需要在程式中添加許多描述性注釋，最值得養成的習慣之一是，在代碼中撰寫清晰、簡潔的注釋，
如果不確定是否要撰寫注釋，就問問自己，找到合理的解決方案前，是否考慮了多個解決方案，如果答案是肯定的，就撰寫注釋對你的解決方案進行說明吧，相比回過頭再去添加注釋，洗掉多余的注釋要容易的多，
2 Python之禪
編程語言Perl曾在互聯網領域長期占據著統治地位，早期的大多數互動式網站使用的都是Perl腳本，彼時，“解決問題的辦法有多個”被Perl社區奉為座右銘，這種理念一度深受大家的喜愛，因為這種語言固有的靈活性使得大多數問題都有很多不同的解決之道，在專案開發期間，這種靈活性是可以接受的，但是大家最終意識到，過于強調靈活性會導致大型專案難以維護：要通過研究代碼搞清楚當時解決復雜問題的人是怎么想的，既困難又麻煩，還會耗費大量的時間，
經驗豐富的程式員倡導避繁就簡，Python社區的理念都包含在Tim Peters寫的“Python之禪”當中，要獲悉這些有關撰寫優秀Python代碼的指導原則，只需在解釋器當中執行命令import this，這里不打算講述整個“Python之禪”，而只與大家分享其中的幾條原則，然你明白為什么它們對你來說至關重要，
>>>import this The Zen of Python, by Tim Peters Beautiful is better than ugly.
Python程式員篤信代碼可以撰寫得漂亮而優雅，編程是要解決問題的，設計良好、高效而漂亮的解決方案都會讓程式員心生敬意，隨著你對Python的認知越來越深入，并使用它來撰寫越來越多的代碼，有一天也許會有人站在你后面驚呼：“哇，這代碼撰寫的真是漂亮！”
Simple isbetter than complex.
如果有兩個解決方案，一個簡單，一個復雜，但是都行之有效，就選擇簡單的解決方案吧，這樣，你撰寫的代碼將更容易維護，你或他人以后改進這些代碼時也會更加容易，
Complex is better than complicated.
現實是復雜的，有時候可能沒有簡單的解決方案，在這種情況下，就選擇最簡單可行的解決方案吧，
Readability counts.
即便是復雜的代碼，也要讓它易于理解，開發的專案涉及復雜代碼時，一定要為這些代碼撰寫有益的注釋，
There should be one-- and preferably only one --obviors way to do it
如果讓兩名Python程式員去解決同一個問題，他們提供的解決方案應大致相同，這并不是說編程沒有創意空間，而是恰恰相反！然而，大部分編程作業都是使用常見解決方案來解決簡單的小問題，但是這些小問題都是包含在更龐大、更具創意的專案當中，在你的程式之中，各種具體細節對其他Python程式員來說都應易于理解，
Now is better than never.
你可以將余生都用來學習Python和編程的紛繁難懂之處，但是這樣你什么專案都完不成，不要企圖撰寫完美無缺的代碼；先撰寫行之有效的代碼，再決定是否對其做進一步改進，還是轉而去撰寫新的代碼，
此后，務必這種簡約而清晰的理念，如此，經驗豐富的程式員定將對你撰寫的代碼心生敬意，進而樂意向你提供反饋，并與你合作開發有趣的專案，
轉載請註明出處，本文鏈接：https://www.uj5u.com/qita/142971.html
標籤：其他
下一篇：Python之禪