PHP · COSCIA 开发手册

### PHP开发规范 **遵从 ThinkPHP 规范** 首先要遵从 ThinkPHP 3.2开发手册的开发命名规范，如控制器，模型，视图的命名，大小写等在此基础上补充大家约定好的一些开发规范； **开发代码规范** 1、函数文件都应该放在 Application\Common\Common\function.php 文件里面，做为全局的可调用的函数；函数名字采用 C GNU的惯例，命名使用小写字母和下划线的方式，例如: > get_client_ip ~~~ /** * 加载配置文件支持格式转换仅支持一级配置 * @param string $file 配置文件名 * @return array */ function load_config($file) { $arr = array(); } ~~~ 2、需要引用非 ThinkPHP 约定的第三方类库文件或在开发过程中封装的类库文件都放在 Application\Common\Util 目录下面， * 第三方类库直接创建新的文件夹，调用 * 封装的类库只是单文件可以直接放在目录中 > 类调用方法： > import("Common.Util.ZhenPin.Zhenpin"); // 加载文件 > $zhenpin = new \Zhenpin(); // 实例化类 > $zhenpin->qryProductDetail(); // 调用方法 3、项目中公共的操作方法的封装，如果是全局的需要的情况，封装放到Application\Common\Controller\BaseController.class.php 文件里面 4、类命名方法 * 类的方法和属性命名规范使用驼峰命名，区别于函数命名，例如: > getUserName > _parseType 通常下划线开头的方法属于私有方法； * 类中方法的参数命名，第一个字符使用小写字母，在首字符后的所有字都按照类命名规则首字符大写； ~~~ class Goods { private $imgName; // 图片名 @var array // 获取图片信息 public function getImageInfo($imgUrl) { $this->imgName = $imgUrl['name']; } } ~~~ 5、变量的命名所有字母都使用小写，使用'_'作为每个词的分界，例如： > $user_name 6、控制器传值模版的方法名，参考变量的命名方式，区别于操作方法名称 > $this->assign('user_list', $result) 7、常量所有字母都必须大写，单词间用下划线分隔 > APP_PATH 8、代码区间空格在 "()"括号内不能出现空格，括号外一定有空格，参数之间一定有空格，"="、"." 、";"、"=>"、"as"等符号左右一定有有空格 ~~~ if ($var) { // if } elseif ($body) { // else } else { // end; } ~~~ 9、所有的名称中，都不能出现数字的方式的命名和拼音的命名，例如，变量 > $var1，$va2, > $dingdan 10、代码必须保持使用4个空格为标准的缩进，在进行数据库查询的时候调用的方法使用比较多，要进行换行，并且缩进，例如： ~~~ $result = M("User") ->field('user.name as uname, user.title as utitle') ->where('type=1 AND status=1') ->order('id desc') ->select(); ~~~ 11、Ajax 返回信息写法，统一的写法三个参数： success 是否成功状态 code 返回代码 msg 返回提示信息 ~~~ if ($data) { $result = array("success"=>true, 'code'=>200, 'msg'=>'保存成功！'); } else { $result = array("success"=>false, 'code'=>401, 'msg'=>'保存失败！'); } $this->ajaxReturn($result); ~~~ * * * * * **开发代码注释** 友好的开发更需要有规范化的注释，因此，约定好几种开发场景中必须要有相关的注释加以说明 1、在每一次数据库操作的代码前面都要加上相关的说明注释进行描述说明 ~~~ // 查询用户列表 $res = M('User')->select(); ~~~ 2、在封装的函数和方法的前面都要有详细的注释进行描述说明，包含，说明信息，参数信息，返回信息，创建人，时间，如果是更新写上更新说明 ~~~ /** * 编译文件 * @param string $filename 文件名 * @return array * @creator jig 2017-3-1 */ ~~~ 3、在类文件的头部都要有描述说明，包括说明信息，版本号，创建人，日期等，在方法前面注明怎么使用说明，参数调用说明，返回说明 ~~~ /** * * API Goods * 电商平台商品 * Jig 2016-12-9 * */ class Goods { private $imgName; // 图片名 @var array // 获取图片信息 @param $imgUrl 图片名称 public function getImageInfo($imgUrl) { $this->imgName = $imgUrl['name']; } } ~~~ **注：**封装的公共的类方法的一定要有更加相信的使用说明 4、在非本文件内的外部函数和类库方法调用使用都要加上注释以说明调用情况 ~~~ $result = object_to_array($obj_data); // 调用封装函数将对象转为数组 ~~~ * * * * * **约定一些工作习惯** 1、PHP代码文件必须以不带BOM的 UTF-8 编码，声明文件编码 2、项目的 Framework 目录下面的文件不要随意改动，如果出现需要增加文件或者修改的情况，请与团队成员做请示沟通，约定好后再做修改 3、每天早上上班第一件事情都应该是更新代码，养成及时更新代码的习惯 4、每天下班前必须将当天的代码提交到 SVN, 并且养成写好注释的习惯 5、我们的开发遵循开发结构，相关的代码应该写在相应的不同架构地方，例如，html 模版文件中，不要写任何的 Javascript 代码，在 Public 有合理的目录结构和文件写 Javascript 代码 * * * * * **开发中常用的方法命名** 1、index 默认列表页面 2、search 搜索结构页 3、export 导出 4、import 导入 5、view 详情页 6、add 新增 7、save 保存新增 8、edit 编辑 9、update 更新编辑 #### 大家有异议和更好的建议，提交到我这里，该页面也会陆续更新... 一个非常有意思的PHP代码习惯统计 https://segmentfault.com/a/1190000000443795