# 簡介說明
## 前言
* 閱讀本文后,當你發現自己在工作過程中出現過同樣的錯誤并理解明白,那么收藏本文,并在日后時常重新閱讀。因為多數人的記憶力無法在你第一次閱讀本文后就能記住,更無法深刻理解并運用在實際工作中。
* 編寫代碼時,時刻提醒自己所寫下的代碼將會被他人閱讀和使用。多數新手程序猿疏于嚴謹會無意地寫下令人難以準確理解的代碼,包括變量名,方法名和條件判斷等,這些代碼在日后閱讀時可能就連他本人也是一知半解。
* 代碼的可讀性尤為重要,代碼易讀易懂,有利于以下幾點:
1. 理解作用
2. 修改bug
3. 正確調用
4. 優化代碼
* 文中所舉例的代碼存在片面性,尤其是涉及到抽象思維的代碼片段,這些并無法完全準確地表述相應的設計細想理念,僅作為淺顯易懂的參考理解。若想真正地理解其中的設計模式細想,請結合理論書籍知識和實踐編寫代碼來領悟。
## 文檔內容
* 修改完善了參考內容中部分文字描述。
* 參考Robert C. Martin的[《Clean Code》](https://www.amazon.com/Clean-Code-Handbook-Software-Craftsmanship/dp/0132350882)
* 參考jupeter的[clean-code-php](https://github.com/jupeter/clean-code-php)
## 參與文檔
歡迎提交并參與完善
## 關于作者
* PHP程序員
* [http://chenbo.site](http://chenbo.site)
* [https://github.com/YWNA](https://github.com/YWNA)