PHP编码规范及建议

PHP编码规范及建议

<h3 align=”center”>PHP编码规范及建议</h3>

### 编码规范

– PHP代码文件必须以 <?php 标签开始。

“`
<?php //开头

// 不结尾
“`

– PHP代码文件必须以不带BOM的UTF-8编码。

“`
例sublime, setting增加,”show_encoding” : true
“`

– 每行的字符数不超过 80 个字符

“`
例,sublime
“word_wrap”: “true”,
“wrap_width”: 80,
“`

– tap键4个空格

“`
例,sublime
“tab_size”: 4,
“`

– PHP代码中应该只定义类(trait)/函数/常量/其他会产生副作用的操作(如:生成文件输出以及修改 .ini 配置文件等),只能选其一。

“`
例,
a.php
class A
{

}

b.php
function demo()
{

}

c.php
define(‘A’, value);

d.php
ini_set(‘some_vars’, value);
“`

– 类/trait/Interface的命名必须遵循 StudlyCaps 大写开头的驼峰命名规范。

“`
class StudlyCaps
{

}

trait StudlyCaps
{

}

Interface StudlyCaps
{

}

“`

– 类中的常量所有字母都必须大写,单词间用下划线分隔。

“`
define(‘FOO_BAR’, ‘something more’);

const FOO_BAR = value;

“`

– 方法(类/trait中)名称必须符合 camelCase 式的小写开头驼峰命名规范。

“`
class StudlyCaps
{

    public function studlyCaps()
    {

        // coding…
    }
}

“`

– 函数名称必须符合 snake_case 式的下划线式命名规范。

“`
function snake_case()
{

    // coding…
}

“`

– 私有的(private)方法(类/trait中)名称必须符合 _camelCase 式的前置下划线小写开头驼峰命名规范。

“`
class StudlyCaps
{

    private function _studlyCaps()
    {

        // coding…
    }
}

“`

– 方法名称 第一个单词 为动词。

“`
class StudlyCaps
{

    public function doSomething()
    {

        // coding…
    }
}

“`

– 变量 必须符合 camelCase 式的小写开头驼峰命名规范。

“`

class StudlyCaps
{

    public function doSomething()
    {

        $someVariable = ‘demo’;
        // coding…
    }
}

“`

– 方法/函数 多参数时,之间要有1个空格

“`

class StudlyCaps
{

    public function doSomething($variableOne, $variableTwo)
    {

        // coding…
    }
}

“`

– 运算符/表达式 要有一个空格

“`
$a = $b + $c;
$a = $b . $c;

“`

– 每个 namespace 命名空间声明语句块 和 use 声明语句块后面,必须 插入一个空白行。

“`
namespace Standard;
// 空一行
use Test\TestClass;//use引入类
// 空一行
“`

– 类的开始花括号 “{ “必须 写在函数声明后自成一行,结束花括号”}”也必须写在函数主体后自成一行。

“`
class StudlyCaps
{

}
“`

– 方法/函数的开始花括号 { 必须 写在函数声明后自成一行,结束花括号 }也 必须 写在函数主体后自成一行。

“`
class StudlyCaps
{

    public function studlyCaps()
    {

        // coding…
    }
}

function snake_case()
{

    // coding…
}

“`

– 类的属性和方法 必须 添加访问修饰符(private、protected 以及 public),abstract 以及 final 必须 声明在访问修饰符之前,

而 static 必须 声明在访问修饰符之后。

“`
abstract class StudlyCaps
{

    abstract public function studlyCaps();

    final public static function studlyCapsOne()
    {

    }
}

“`

– 控制结构的关键字后 必须 要有一个空格符,而调用方法或函数时则 一定不可 有。

“`
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();

“`

– 控制结构的开始花括号 { 必须 写在声明的同一行,而结束花括号 } 必须 写在主体后自成一行。

“`
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…
}
“`

– 控制结构的开始左括号后和结束右括号前,都一定不可有空格符。

“`
if ($valueOne === $valueTwo) {// 控制结构(右边和)左边不加空格
  // code…
}
“`

### 编码建议

– sql过长

“`
// 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;
“`

– if等控制结构条件过长

“`
if ($a > 0
    && $b > 0
    && $c > 0
    && $d > 0
    && $e > 0) {

}
“`

– 方法或函数参数大于三个换行

“`
public function tooLangFunction(
      $valueOne   = ”,
      $valueTwo   = ”,
      $valueThree = ”,
      $valueFour  = ”,
      $valueFive  = ”,
      $valueSix   = ”)
{

    //coding…
}
“`

– 链式操作超过两个

“`
$this->nameTest->functionOne()
               ->functionTwo()
               ->functionThree();
“`

– 数组php5.4以后,使用[]

“`
$a = [
    ‘aaa’ => ‘aaa’,
    ‘bbb’ => ‘bbb’
];
“`

– 单引号多引号
    – 字符串中无变量,单引号
    – 字符串中有变量,双引号

“`
$str = ‘str’;
$arg = “$str”;
“`

– 声明类或者方法或函数添加描述&属性描述&作者

“`
/**
 * 类描述
 *
 * 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…
  }
“`

– api方法提供测试样例example

“`
/**
 * 成员方法名称.
 *
 * 成员方法描述
 *
 * @param  string $value 形参名称/描述
 *
 * @example domain/api/controller/action?argu1=111&argu2=222
 */
public function testFunction($value = ”)
{

    // code…
}
“`

– 使用try…catch…

“`
try {

    // coding…

} catch (\Exception $e) {

  // coding…
}

“`

– 连续调用多个方法(大于3个)使用foreach

“`
// 改写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();
      }
  }

  …
}
“`

– 文件顶部进行版权声明

“`
// +———————————————————————-
// | Company Name  xx服务
// +———————————————————————-
// | Copyright (c) 2017 http://domain All rights reserved.
// +———————————————————————-
// | Author: name <email>
// +———————————————————————-
“`

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

发布者:全栈程序员-用户IM,转载请注明出处:https://javaforall.cn/113818.html原文链接:https://javaforall.cn

【正版授权,激活自己账号】: Jetbrains全家桶Ide使用,1年售后保障,每天仅需1毛

【官方授权 正版激活】: 官方授权 正版激活 支持Jetbrains家族下所有IDE 使用个人JB账号...

(0)


相关推荐

  • elasticSearch字段类型大全

    elasticSearch字段类型大全ES字段类型核心数据类型String类型:text、keyworknumber类型:long,integer,short,byte,double,float,half_float,scaled_floatdate类型:dateboolean类型:booleanbinary类型:binaryrange类型:integer_range,float_range,long_range,double_range,date_range复杂数据类型对象数据类型:object用

  • MySql必知必会实战练习(六)游标

    游标主要用于交互式应用,滚动屏幕上的数据,并对数据进行浏览或做出更改看一下下面的例子:输出:由于结果为多行无法显示,这时我们就需要使用游标来操作1.游标基本方法(1)创建游标(2)打开游

    2021年12月29日
  • 匿名函数调用方法_javascript匿名函数

    匿名函数调用方法_javascript匿名函数首先看一下普通函数和匿名函数的区别//普通函数functionsum(a,b){ returna+b; console.log(“我是一个普通函数”) }//匿名函数,不能单独使用function(a,b){ returna+b; console.log(“我是一个匿名函数”) }没错,匿名函数简单来说就是普通函数去掉名字,但是他不能单独定义与使用,下面是匿名函数的一些使用场景:用于函数表达式、作为返回值、用于定义对象方法、作为回调函数、用于立即执行函数、用于DOM元素注

  • Ubuntu安装GCC

    Ubuntu安装GCC第一步:更新包列表sudoaptupdate第二步:安装build-essential软件包:sudoaptinstallbuild-essential

  • Pycharm介绍_怎么用pycharm

    Pycharm介绍_怎么用pycharm一.开发环境介绍每一个项目可能有不同的开发环境,而为了解决这一冲突,pycharm采用了两种环境设置方式:一个是虚拟环境方式:也就是每一个项目配置一个环境,在项目中为venv文件夹创建项目时意味着每一个项目都copy一份新的开发环境,而彼此之间相互独立还有一种方式为采用公用的一个开发环境,常用于各项目之间不会互相影响的情况二.pycharm快捷键Ctrl+Alt+L注释Ctrl+/行注释Ctrl+Alt+L代码格式化Ctrl+D复制当前行三.注释

    2022年10月26日
  • 电商项目商品详情页架构设计[通俗易懂]

    电商项目商品详情页架构设计

发表回复

您的电子邮箱地址不会被公开。

关注全栈程序员社区公众号