API规范与重构

背景:目前整体代码质量较差,出现写法随意无统一规范,一会驼峰一会下划线,变量定义词义不明,声明无用变量,代码格式混乱,一会4个空格,一会3个,无用的注释代码,debug代码,随意无明确意思的换行等等问题
导致
1.代码可读性差,新人接手困难,代码无法阅读需要问人浪费大量沟通成本
2.代码乱不可重用,业务扩展或修改,又是copy重写,浪费人力精力
解决
首先第一点要使用phpstorm IDE(在vip大家都用,4399php开发要求使用),以上各种问题在这个IDE下会暴露的非常明显,因为都有提示,各种工具齐全,各种错误提示,很大提高工作效率。用sublime…(省略1万字)
1.编码风格规范.
http://www.php-fig.org/psr/ 按照php官方推荐的规范,特别是psr2。 以下提出几点重要的换行和空格的使用
1. 变量统一使用驼峰命名
2. 使用4个空格 做分隔
3. 空格和换行使用如下

<?php
namespace Vendor\Package; //namespace 跟use 空一行

use FooInterface;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;//use 跟 class空一行

class Foo extends Bar implements FooInterface //声明类的{}要换行
{   //声明函数的{}要换行,变量之间逗号后面跟一个空格
    public function sampleMethod($a, $b = null) 
    {
        if ($a === $b) { //这里注意if后和判断语句后要加空格,下面同理
            bar();
        } elseif ($a > $b) {
            $foo->bar($arg1);
        } else {
            BazClass::bar($arg2, $arg3);
        }
    }

    final public static function bar()
    {
        try { //这里也是注意空格使用
            // try body
        } catch (FirstExceptionType $e) {
            // catch body
        } catch (OtherExceptionType $e) {
            // catch body
        }
    }
}

4.代码中尽量对齐 = 和-> 等符号 下面是举例
代码中尽量对齐 = 和-> 等符号
2.db规范
1.表名使用下划线连接 例如ams_advertiser
2.db名字,表名,字段名字都要用明确意思的单词,而且必须要完整的单词 pub-> publisher ,conv->conversion 等。编码变量可以有一定程度的缩写,db必须写全,除非有人尽皆知的缩写。

3.上线规范
队员无权限push到master分支(gitosc可以设置),由 项目负责人 review包括代码,db变更,计划任务等,再合并各成员分支到master分支,线上server更新,这个也就保证了上述规范得到一定的把控!
在vip提测之前还要写提测文档给测试,即需求的技术方案,修改了哪些点。
团队建设
技术团队定期做内部培训和code review是促进团队交流,维护团队健康进步的好方式。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值