PHP 编码规范及建议

hnau8974 4年前
   <p>最近又在推动公司内部PHPer们代码规范化,今天我整理了一下贴出来以供大家参考。</p>    <h3>编码规范</h3>    <ul>     <li>PHP代码文件必须以 <?php 标签开始。</li>    </ul>    <pre>  <?php //开头    // 不结尾  </pre>    <ul>     <li>PHP代码文件必须以不带BOM的UTF-8编码。</li>    </ul>    <pre>  例sublime, setting增加,"show_encoding" : true  </pre>    <ul>     <li>每行的字符数不超过 80 个字符</li>    </ul>    <pre>  例,sublime  "word_wrap": "true",  "wrap_width": 80,  </pre>    <ul>     <li>tap键4个空格</li>    </ul>    <pre>  例,sublime  "tab_size": 4,  </pre>    <ul>     <li>PHP代码中应该只定义类(trait)/函数/常量/其他会产生副作用的操作(如:生成文件输出以及修改 .ini 配置文件等),只能选其一。</li>    </ul>    <pre>  例,  a.php  class A  {    }    b.php  function demo()  {    }    c.php  define('A', value);    d.php  ini_set('some_vars', value);  </pre>    <ul>     <li>类/trait/Interface的命名必须遵循 StudlyCaps 大写开头的驼峰命名规范。</li>    </ul>    <pre>  class StudlyCaps  {    }    trait StudlyCaps  {    }    Interface StudlyCaps  {    }  </pre>    <ul>     <li>类中的常量所有字母都必须大写,单词间用下划线分隔。</li>    </ul>    <pre>  define('FOO_BAR', 'something more');    const FOO_BAR = value;  </pre>    <ul>     <li>方法(类/trait中)名称必须符合 camelCase 式的小写开头驼峰命名规范。</li>    </ul>    <pre>  class StudlyCaps  {      public function studlyCaps()      {          // coding...      }  }  </pre>    <ul>     <li>函数名称必须符合 snake_case 式的下划线式命名规范。</li>    </ul>    <pre>  function snake_case()  {      // coding...  }  </pre>    <ul>     <li>私有的(private)方法(类/trait中)名称必须符合 _camelCase 式的前置下划线小写开头驼峰命名规范。</li>    </ul>    <pre>  class StudlyCaps  {      private function _studlyCaps()      {          // coding...      }  }  </pre>    <ul>     <li>方法名称 第一个单词 为动词。</li>    </ul>    <pre>  class StudlyCaps  {      public function doSomething()      {          // coding...      }  }  </pre>    <ul>     <li>变量 必须符合 camelCase 式的小写开头驼峰命名规范。</li>    </ul>    <pre>  class StudlyCaps  {      public function doSomething()      {          $someVariable = 'demo';          // coding...      }  }  </pre>    <ul>     <li>方法/函数 多参数时,之间要有1个空格</li>    </ul>    <pre>  class StudlyCaps  {      public function doSomething($variableOne, $variableTwo)      {          // coding...      }  }  </pre>    <ul>     <li>运算符/表达式 要有一个空格</li>    </ul>    <pre>  $a = $b + $c;  $a = $b . $c;  </pre>    <ul>     <li>每个 namespace 命名空间声明语句块 和 use 声明语句块后面,必须 插入一个空白行。</li>    </ul>    <pre>  namespace Standard;  // 空一行  use Test\TestClass;//use引入类  // 空一行  </pre>    <ul>     <li>类的开始花括号 “{ “必须 写在函数声明后自成一行,结束花括号”}”也必须写在函数主体后自成一行。</li>    </ul>    <pre>  class StudlyCaps  {    }  </pre>    <ul>     <li>方法/函数的开始花括号 { 必须 写在函数声明后自成一行,结束花括号 }也 必须 写在函数主体后自成一行。</li>    </ul>    <pre>  class StudlyCaps  {      public function studlyCaps()      {          // coding...      }  }    function snake_case()  {      // coding...  }  </pre>    <ul>     <li>类的属性和方法 必须 添加访问修饰符(private、protected 以及 public),abstract 以及 final 必须 声明在访问修饰符之前,而 static 必须 声明在访问修饰符之后。</li>    </ul>    <pre>  abstract class StudlyCaps  {   abstract public function studlyCaps();     final public static function studlyCapsOne()   {     }  }  </pre>    <ul>     <li>控制结构的关键字后 必须 要有一个空格符,而调用方法或函数时则 一定不可 有。</li>    </ul>    <pre>  if ($valueOne === $valueTwo) {    // code...  }    switch ($valueThree) {    case 'value':      // code...      break;      default:      // code...      break;  }    do {    // code...  } while ($valueFour <= 10);    while ($valueFive <= 10) {    // code...  }    for ($i = 0; $i < $valueSix; $i++) {    // code...  }    $demo = new Demo()  $demo->doSomething();    do_something();  </pre>    <ul>     <li>控制结构的开始花括号 { 必须 写在声明的同一行,而结束花括号 } 必须 写在主体后自成一行。</li>    </ul>    <pre>  if ($valueOne === $valueTwo) {    // code...  }    switch ($valueThree) {    case 'value':      // code...      break;      default:      // code...      break;  }    do {    // code...  } while ($valueFour <= 10);    while ($valueFive <= 10) {    // code...  }    for ($i = 0; $i < $valueSix; $i++) {    // code...  }  </pre>    <ul>     <li>控制结构的开始左括号后和结束右括号前,都一定不可有空格符。</li>    </ul>    <pre>  if ($valueOne === $valueTwo) {// 控制结构(右边和)左边不加空格    // code...  }  </pre>    <h3>编码建议</h3>    <ul>     <li>sql过长</li>    </ul>    <pre>  // heredoc语法  $sql = <<<SQL  SELECT delivery_id  FROM d_test  WHERE delivery_id  IN (123,234)  GROUP BY delivery_id  HAVING SUM(send_number) <= 0;  SQL;  </pre>    <ul>     <li>if等控制结构条件过长</li>    </ul>    <pre>  if ($a > 0      && $b > 0      && $c > 0      && $d > 0      && $e > 0) {    }  </pre>    <ul>     <li>方法或函数参数大于三个换行</li>    </ul>    <pre>  public function tooLangFunction(        $valueOne   = '',        $valueTwo   = '',        $valueThree = '',        $valueFour  = '',        $valueFive  = '',        $valueSix   = '')  {      //coding...  }  </pre>    <ul>     <li>链式操作超过两个</li>    </ul>    <pre>  $this->nameTest->functionOne()                 ->functionTwo()                 ->functionThree();  </pre>    <ul>     <li>数组php5.4以后,使用[]</li>    </ul>    <pre>  $a = [      'aaa' => 'aaa',      'bbb' => 'bbb'  ];  </pre>    <ul>     <li>单引号多引号      <ul>       <li>字符串中无变量,单引号</li>       <li>字符串中有变量,双引号</li>      </ul> </li>    </ul>    <pre>  $str = 'str';  $arg = "$str";  </pre>    <ul>     <li>声明类或者方法或函数添加描述&属性描述&作者</li>    </ul>    <pre>  /**   * 类描述   *   * desc   */  class StandardExample  {    /**     *  常量描述.     *     * @var string     */    const THIS_IS_A_CONST = '';      /**     * 属性描述.     *     * @var string     */    public $nameTest = '';      /**     * 构造函数.     *     * 构造函数描述     * @author name <email>     * @param  string $value 形参名称/描述     * @return 返回值类型        返回值描述     * 返回值类型:string,array,object,mixed(多种,不确定的),void(无返回值)     */    public function __construct($value = '')    {      // coding...    }  </pre>    <ul>     <li>api方法提供测试样例example</li>    </ul>    <pre>  /**   * 成员方法名称.   *   * 成员方法描述   *   * @param  string $value 形参名称/描述   *   * @example domain/api/controller/action?argu1=111&argu2=222   */  public function testFunction($value = '')  {      // code...  }  </pre>    <ul>     <li>使用try…catch…</li>    </ul>    <pre>  try {        // coding...    } catch (\Exception $e) {    // coding...  }  </pre>    <ul>     <li>连续调用多个方法(大于3个)使用foreach</li>    </ul>    <pre>  // 改写doSome为doSomething  class StandardExample  {    /**     * 方法列表     *     * @var array     */    private $_functionList = [];      public function __construct($functionList = array())    {      $this->_functionList = $value;    }      public function doSome()    {      $this->functionOne();      $this->functionTwo();      $this->functionThree();      $this->functionFour();    }      public function doSomething()    {        foreach($this->_functionList as $function) {            $this->$function();        }    }      ...  }  </pre>    <ul>     <li>文件顶部进行版权声明</li>    </ul>    <pre>  // +----------------------------------------------------------------------  // | Company Name  xx服务  // +----------------------------------------------------------------------  // | Copyright (c) 2017 http://domain All rights reserved.  // +----------------------------------------------------------------------  // | Author: name <email>  // +----------------------------------------------------------------------  </pre>    <p> </p>    <p>来自:http://tigerb.cn/2017/03/06/standard/</p>    <p> </p>