php开发规范和项目进度把控要素(中小型公司)

目的

提高开发人员效率以及代码合理性，最大程度提高代码的可维护性和可读性。注意:该文档不对具体项目进行分析 （最近要离职了,boss需要我将这些整理出来）

1 代码目录

项目启动前期一定要把代码结构整理出来

应用目录结构中的配置  模型 控制器  视图层 文件上传 第三方类库等目录进行文档整理 且保证团队每个人都知晓，包括新入职的程序员都必须知晓该文档

如:

webroot

     config

     model

     controller

     view

    upload

    vendor

2 注释规范

类注释

类描述+类作者+类时间 +重要的使用说明

如:

// +----------------------------------------------------------------------
// | ACZT [ WE CAN DO ONE ]
// +----------------------------------------------------------------------
// | Copyright (c) 2016~2017 http://www.zt-tech.net All rights reserved.
// +----------------------------------------------------------------------
// | Important 方法只能内部调用
// +----------------------------------------------------------------------
// | Author: 32个字符 
// +----------------------------------------------------------------------

方法注释

方法描述+所需参数+返回值类型+作者

/**
 * 执行参数过滤
 * @access public
 * @param Request $request Request对象
 * @return Response
 * @author 32个字符 
 */

3变量命名(0 0 0 程序的可读性、可移植性和可重用性，大大提高开发效率。)

常规变量

有意义(汉语拼音 拼音缩写 统统都不要)

推荐一个变量命名网站

http://unbug.github.io/codelf/

多个变量使用“_”分割

全局变量

global $GLOBAL_TEST;

global $GLOBAL_PROJECT;

4代码规范

    /**
     * 博客举例
     * @param array $param 参数说明
     * @return array
     * @author 开发者
     */
    public function check($param = array())
    {
        if( isset($param) ){
            $param['one'] = 1;
        }
        return $param;
    }

  4.1注释  代码缩进 代码判断（）{}使用
  一定要让自己代码看起来清晰明朗  让别人能看懂

  4.2代码中注意不要出现以下情况

  if($state == 1)

  不要出现这种数字 1 可定义常量来规定

  define("GOODS_STATE","1");

 

这种未使用的变量全删掉或者注释掉(出现最多次数在修改代码的情况下 修改不彻底)

4.3定义确定的字符串用单引号 '单引号'  有拼接变量的使用双引号 "双引号$double"  

4.4按照项目情况合理使用 if 和 switch case

不要出现一堆if

 

这种代码完全可以使用switch case来代替

4.5 搞清楚这几种变量的关系

    $a = "";  $b = null;  $c = array();  $d = false; $e = 0;

5代码管理(项目必备)

使用svn或者git进行管理 每次的更新  合并 等操作一定要记得 写注释 写注释 写注释

6接口相关

 要学会看日志(服务器日志) 写日志(自己写日志) 

 要有标准的接口文档

未完待续