# 简介说明 ## 前言 * 阅读本文后，当你发现自己在工作过程中出现过同样的错误并理解明白，那么收藏本文，并在日后时常重新阅读。因为多数人的记忆力无法在你第一次阅读本文后就能记住，更无法深刻理解并运用在实际工作中。 * 编写代码时，时刻提醒自己所写下的代码将会被他人阅读和使用。多数新手程序猿疏于严谨会无意地写下令人难以准确理解的代码，包括变量名，方法名和条件判断等，这些代码在日后阅读时可能就连他本人也是一知半解。 * 代码的可读性尤为重要，代码易读易懂，有利于以下几点： 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)