11个最佳PHP编码规范课件.ppt

最佳 11 个 PHP 编码规范 二零一四年二月三日 技术部 目录 一、代码规范的重要性 三、后记 二、代码规范的要求 2 代码规范的重要性 促进团队合作 降低维护成本 有助代码审查 减少 BUG 处理 有助自身成长 3 促进团队合作 ? 项目是由一个团队来完成，如果没有统 一的代码规范，那么每个人的代码必定 会风格迥异。 ? 多个人同时开发同一模块，等到要整合 代码的时候也有够头疼的了。 ? 可读性 4 减少 BUG 处理 ? 减少低级错误； ? 再复杂的逻辑看起来也是清清爽爽； ? 乱容易出错； ? 步调一致，减少细节思考； 5 降低维护成本 ? 方便后人进行代码阅读； ? 便于后人进行代码维护； ? 减少程序耦合性；方便后人在前人基础上的 扩展； ? 可维护性； 6 有助于代码审查 ? 代码审查有据可依； ? 减少代码审查的工作量； ? 统一度量标准； 7 有助于程序员自身成长 ? 您能保证之后不需要来维护自己的代码？ ? 在紧张的项目进度要求下，提高自身工作效 率，产生高质量代码； ? 防止以后别人读自己的代码里，心里默默在 说： SHIT ！ ? 高效率，专业； 8 目录 一、代码规范的重要性 三、后记 二、代码规范的要求 9 代码规范的要求 使用 DRY 原则 适当留空和必要缩进 避免深嵌套 使用有意义并一致命名 良好的工程结构 变量申明和初始化 永远不要相信用户 避免代码的 Copy&Paste 合理使用缓存机制 使用框架 添加应有的注释 10 原则 1 ：良好的工程结构 ThinkPHP 有着良好的工程结构： 1 ， Lib ： *Action.php ， *Model.php; 2 ， Tpl ：模板； 3 ， Static ：静态资源； 4 ， Conf ：配置信息； 5 ， Common ：共有文件； 6 ， Kernel ：框架核心代码。 11 原则 2 ：使用 DRY 原则 概念： -- Do not Repeat Yourself ： DRY 原则指的是不要重复你 的代码 ； -- write everything twice ：多次重复打字； DRY 解决方案： -- 拆分可重用函数或类； -- 使用常量定义； 例子： 12 原则 3 ：使用有意义并一致命名 基本原则： -- 杜绝拼音； -- 杜绝没有明确含义的命名： $data2 ； 1 ，变量命名 -- 变量的名词性：形容词 + 名词； -- 长名字可用下划线连接： $new_user; 2 ，函数名 -- 小驼峰式 ：getUserInfo(…)； -- 函数的动词性 ：动词 + 形容词 + 名词； 谓语 + 宾语； 3 ，类的命名 -- 大驼峰式： PageManager ； -- 类的名词性： OrderModel ；不可出现下划线； 13 原则 4 ：适当留空和必要缩进 基本原则： -- 使用 TAB 键缩进：不可使用 4 个空格来代替缩进； -- 留空：使用空格，换行，空行 ； 1 ，缩进： -- 被嵌套的逻辑体需要进行缩进； -- 避免 3 级以上的缩进，这意味出现了深嵌套； 2 ，空格： -- 参数之间留空格： fopen ($file_location_path, 'w') ； 3 ，长代码换行： if ((count($this->languages) == 0) AND isset($_SERVER['HTTP_ACCEPT_LANGUAGE']) AND $_SERVER['HTTP_ACCEPT_LANGUAGE'] != '') ； 4 ，不同逻辑体之间必须空行； 14 原则 5 ：避免深嵌套 基本原则： -- 嵌套不应该大于 3 层； -- 函数不应该有多个出口 ； 15 原则 6 ：添加应有的注释 注释块 /**/ ： -- 文件头：名称，版权，作者； -- 类 ：类作用解释 ； -- 函数 ：函数作用，入参数，返回内容； 注释行 // ：帮助记忆 -- 代码说明