程式設計的 5 個良好習慣
像其他語言一樣，開發人員可以用 PHP 編寫出各種質量級別的程式碼。學習良好的程式設計習慣能夠提高程式碼質量和效率。
根據具體的情況，一般的開發人員往往比優秀的開發人員的效率低 10%~20%。優秀的開發人員的效率更高，因為他們擁有豐富的經驗和良好的程式設計習慣。不良的程式設計習慣將會影響到效率。本文通過展示一些良好的程式設計習慣，幫助您成為更優秀的程式設計師。
這些良好的程式設計習慣不僅能提高效率，還能讓您編寫出在應用程式的整個生命週期中易於維護的程式碼。編寫出來的程式碼可能需要大量的維護；應用程式的維護是一筆很大的開支。養成良好的程式設計習慣能夠提高設計質量（比如模組化），從而使程式碼更加容易理解，因此維護就更加容易，同時也降低維護成本。
不良的程式設計習慣會造成程式碼缺陷，使其難以維護和修改，並且很可能在修改時又引入其他缺陷。以下是 5 個良好的程式設計習慣，能夠幫助 PHP 程式碼避免這些缺陷：
1. 使用良好的命名。
2. 分成更小的部分。
3. 為程式碼添加註釋。
4. 處理錯誤條件。
5. 切忌使用複製貼上。
下一小節將詳細介紹這些習慣。
使用良好的命名
使用良好的命名是最重要的程式設計習慣，因為描述性強的名稱讓程式碼更加容易閱讀和理解。程式碼是否好理解取決於是否能在未來維護它。即便程式碼不帶有註釋，如果它很容易理解，將大大方便日後的更改。這個習慣的目標是讓您編寫的程式碼像書本一樣容易閱讀和理解。
不良習慣：含糊的或無意義的名稱
清單 1 中的程式碼包含過短的變數名、難以辨認的縮寫詞，並且方法名不能反映該方法的功能。如果方法名給人的感覺是它應該做這件事情，而實際中它卻做另外的事情，這將帶來嚴重的問題，因為它會誤導人。
清單 1. 不良習慣：含糊的或無意義的名稱
良好習慣：說明性強並且簡潔的名稱
清單 2 中的程式碼體現了良好的程式設計習慣。新的方法名具有很強的說明性，反映了方法的用途。同樣，更改後的變數名也更具說明性。惟一的保持最短的變數是$i，在本清單中，它是一個迴圈變數。儘管很多人不贊同使用過短的名稱，但在迴圈變數中使用還是可以接受的（甚至有好處），因為它明確表明了程式碼的功能。
清單 2. 良好習慣：說明性強並且簡潔的名稱
我們鼓勵您將大的條件拆分為一個方法，然後用能夠描述該條件的名字命名方法。這個技巧能夠提高程式碼的可讀性，並且能夠將條件具體化，使之能夠被提取甚至重用。如果條件發生變化，更新方法也很容易。因為方法擁有一個有意義的名字，所以它能反映程式碼的用途，讓程式碼更容易閱讀。
分成更小的部分
專心解決一個問題之後再繼續程式設計，這樣會讓您更輕鬆。在解決一個緊急的問題時，如果繼續程式設計，會使函式越來越長。從長遠來說，這並不是一個問題，但您要記得回過頭來將它重構為更小的部分。
重構是個不錯的主意，但您應該養成編寫更短、功能更集中的程式碼。短的方法能夠在一個視窗中一次看完，並且容易理解。如果方法過長，不能在一個視窗中一次看完，那麼它就變得不容易理解，因為您不能快速地從頭到尾瞭解它的整個思路。
構建方法時，您應該養成這樣的習慣，讓每個方法只完成一件事情。這個習慣很好，因為：首先，如果方法只完成一件事情，那麼它就更容易被重用；其次，這樣的方法容易測試；第三，這樣的方法便於理解和更改。
不良習慣：過長的方法（完成很多件事情）
清單 3 展示了一個很長的函式，其中存在很多問題。它完成很多件事情，因此不夠緊湊。它也不便於閱讀、除錯和測試。它要做的事情包括遍歷一個檔案、構建一個列表、為每個物件賦值、執行計算等等。
清單 3. 不良習慣：過長的函式
如果多編寫幾個這樣的方法，維護就成了真正的難題了。
良好習慣：易管理、功能專一的方法
清單 4 將原來的方法改寫為更加緊湊、易讀的方法。在這個示例中，將一個很長的方法分解為幾個短方法，並且讓每個短方法負責一件事情。這樣的程式碼對將來的重用和測試都是大有裨益的。
清單 4. 良好習慣：易管理、功能專一的方法
將長方法拆分為短方法也是有限制的，過度拆分將適得其反。因此，不要濫用這個良好的習慣。將程式碼分成大量的片段就像沒有拆分長程式碼一樣，都會造成閱讀困難。
為程式碼添加註釋
要為程式碼新增良好的註釋有時似乎和編寫程式碼一樣難。要了解應該為哪些內容添加註釋並不容易，因為我們常常傾向於註釋程式碼當前做的事情。註釋程式碼的目的是不錯的主意。在函式的不是很明顯的頭部程式碼塊中，告訴讀者方法的輸入和輸出，以及方法的最初目標。
註釋程式碼當前做什麼是很常見的，但這是不必要的。如果程式碼很複雜，不得不註釋它當前在做什麼，這將暗示您應該重寫程式碼，讓它更容易理解。學會使用良好的名稱和更短的方法，在不提供註釋說明其用途的情況下提高程式碼的可讀性。
不良習慣：函式註釋過多或不足
清單 5 中的註釋僅告訴讀者程式碼在做什麼 — 它正在通過一個迴圈進行迭代或新增一個數字。但它忽略了它為什麼做當前的工作。這使維護該程式碼的人員不知道是否可以安全地更改程式碼（不引入新缺陷）。
清單 5. 不良習慣：函式註釋過多或不足
良好習慣：帶註釋的函式和類
清單 6 中的註釋告訴讀者類和方法的目的。該註釋解釋了為什麼程式碼在做當前的工作，這對未來維護程式碼十分有用。可能需要根據條件變更而修改程式碼，如果能夠輕鬆瞭解程式碼的目的，則修改起來很容易。
清單 6. 良好習慣：帶註釋的函式和類
處理錯誤
根據大眾的經驗，如果要編寫健壯的應用程式，錯誤處理要遵循 80/20 規則：80% 的程式碼用於處理異常和驗證，20% 的程式碼用於完成實際工作。在編寫程式的基本邏輯（happy-path）程式碼時經常這樣做。這意味著編寫適用於基本條件的程式碼，即所有的資料都是可用的，所有的條件符合預期。這樣的程式碼在應用程式的生命週期中可能很脆弱。另一個極端是，甚至需要花大量時間為從未遇到過的條件編寫程式碼。
這一習慣要求您編寫足夠的錯誤處理程式碼，而不是編寫對付所有錯誤的程式碼，以致程式碼遲遲不能完成。
不良習慣：根本沒有錯誤處理程式碼
清單 7 中的程式碼演示了兩個不良習慣。第一，沒有檢查輸入的引數，即使知道處於某些狀態的引數會造成方法出現異常。第二，程式碼呼叫一個可能丟擲異常的方法，但沒有處理該異常。當發生問題時，程式碼的作者或維護該程式碼的人員只能猜測問題的根源。
清單 7. 不良習慣：不處理錯誤條件
良好習慣：處理異常
清單 8 展示了以有意義的方式丟擲和處理異常。額外的錯誤處理不僅使程式碼更加健壯，它還提高程式碼的可讀性，使程式碼更容易理解。處理異常的方式很好地說明了原作者在編寫方法時的意圖。
清單 8. 良好習慣：處理異常
雖然檢查引數是一種確認 — 如果您要求引數處於某種狀態，這將對使用方法的人很有幫助 — 但是您應該檢查它們並丟擲有意義的異常：
* 處理異常要儘量與出現的問題緊密相關。
* 專門處理每個異常。
切忌使用複製貼上
您可以從其他地方將程式碼複製貼上到自己的程式碼編輯器，但這樣做有利也有弊。好的一面是，從一個示例或模板中複製程式碼能夠避免很多錯誤。不好的一面是，這容易帶來大量的類似程式設計方式。
一定要注意，不要將程式碼從應用程式的一部分複製貼上到另一部分。如果您採用這種方式，請停止這個不良的習慣，然後考慮將這段程式碼重寫為可重用的。一般而言，將程式碼放置到一個地方便於日後的維護，因為這樣只需在一個地方更改程式碼。
不良習慣：類似的程式碼段
清單 9 給出了幾個幾乎一樣的方法，只是其中的值不同而已。有一些工具可以幫助找到複製貼上過來的程式碼（參見參考資料）。
清單 9. 不良習慣：類似的程式碼段
良好習慣：帶引數的可重用函式
清單 10 展示了修改後的程式碼，它將複製的程式碼放到一個方法中。另一個方法也進行了更改，它現在將任務委託給新的方法。構建通用的方法需要花時間設計，並且這樣做使您能停下來思考，而不是本能地使用複製貼上。但有必要進行更改時，對通用的方法投入的時間將得到回報。
清單 10. 良好習慣：帶引數的可重用函式
結束語
如果您在編寫 PHP 程式碼的過程中養成本文討論的良好習慣，您將能夠構建易讀、易理解、易維護的程式碼。使用這種方式構建的易維護程式碼將降低除錯、修復和擴充套件程式碼所面臨的風險。
使用良好的名稱和更短的方法能夠提高程式碼的可讀性。註釋程式碼的目的有利於程式碼理解和擴充套件。適當地處理錯誤會使程式碼更加健壯。最後，停止使用複製貼上，保持程式碼乾淨，提高可重用性。