php 换行输出_PHP-基础编码规范-浅谈篇

最新推荐文章于 2022-08-05 17:03:22 发布

weixin_39617685

最新推荐文章于 2022-08-05 17:03:22 发布

阅读量192

点赞数

文章标签： php 换行输出 php 输出换行 php输出换行

前言：

PHP 作为一种编程语言，有着自己固有的编码规范，作为程序员，使用该语言，就应该严格的遵循着它。

我个人的编码习惯是会在“类”和“类方法”结束符那里加上一些备注，目的在于能够迅速的查看了区分。

<?php
class TestClass
{
    public function add() 
    {
    // body
    }// add() end
}// TestClass{} end

本文中的编码规范都是来自于 PHP PSR-* 的编码规范。

文件

PHP 代码必须使用长标签

<?php ?>

或者短标签

<?= ?>

短标签是要手动开启的，在 PHP 配置文件 “php.ini”中，将

short_open_tag = On

即开启成功，关闭再将“On”设置成“Off”。

所有 PHP 文件必须使用 Unix LF（linefeed）作为行的结束符。linefeed 译“换行”。

所有 PHP 文件必须以一个空白行作为结束。

纯 PHP 代码文件必须省略最后的“?>”结束标签。

行

行的长度一定不可有硬性的约束。

软性的长度约束必须要限制在 120 个字符以内，若超过此长度，代码规范检查的编辑器必须要发出警告，不过一定不可发出错误提示。

每行不该多于 80 个字符，大于 80 字符的行应该折成多行。

非空行后一定不可有多余的空格符。

空行可以使得阅读代码更加方便以及有助于代码的分块。

每行一定不可存在多于一条语句。

缩进

代码必须使用 4 个空格进行缩进，并且一定不能使用 tab 键来缩进。我的编辑器是 PhpStorm，在设置的时候，已经将 tab 键设置成了 4 个空格的大小。

关键字与 True/False/Null

PHP 的关键字必须使用小写形式。

PHP 的常量 true，false，null 必须使用小写形式。

字符集编码

PHP 代码只能使用不带 BOM 的 UTF-8 编码。如下图：

尽管 Unicode 标准是允许带 BOM，但是不带 BOM，才是 UTF-8 的标准形式。带 BOM 是微软的习惯，它这么做，是为了将 UTF-8 和 ASCII 等编码明确区分开，但是这样的文件在 Windows 之外的操作系统里会带来问题。

side effects【副作用】

side effects：仅通过包含文件，不直接声明类、函数和常量等，而执行的逻辑操作。

side effects 包含却不仅限于：生成输出，明确使用 require 或 include，连接到外部服务，修改 ini 设置，发出错误或异常，修改全局或静态变量，读取或写入一个文件，等等。

一份 PHP 文件中应该要不只定义新的声明（如类、函数或常量等不产生 side effects 的操作），要不就只产生 side effects 的逻辑操作，但不该同时具有两者。

以下是一个反例，包含函数声明和产生 side effects 的代码：

<?php
// side effects：修改 ini 配置
ini_set('error_reporting', E_ALL);

// side effects：引入文件
include 'file.php';

// side effects：生成输出
echo "<html>n";

// 声明函数
function foo()
{
    // function body
}// foo() end

下面是一个范例，一份只包含声明不产生 side effects 的代码：

<?php
// 声明函数
function foo()
{
    // 函数主体部分
}// foo() end

// 条件声明 **不** 属于 side effects
if(! function_exists('bar')){
    function bar()
    {
        // 函数主体部分
    }// bar() end
}

命名空间

namespace 声明之后必须存在一个空行。

所有的 use 声明必须位于 namespace 声明之后。

每条 use 声明必须只有一个 use 关键字。

use 语句块之后必须存在一个空行。

<?php
namespace AppController;

use BikesController;
use UserModel as User;
use AppModelsCarModel;

class UsersController
{
}// UsersController{} end

类名

每个类独立为一个文件，并且至少在一个层次的命令空间内。

类名必须以驼峰命名方式声明：

UsersController.php

<?php
namespace AppController;

class UsersController
{
}// UsersController{} end

类常量

类的常量中所有字母都必须大写，词间以下划线分隔。

<?php
namespace AppController;

class UsersController
{
    const VERSION = '1.0';
    const DATE_APPROVED = '2000-01-01';
}// UsersController{} end

类属性

类属性命名规范：

大写开头的驼峰式：$ClassAttribute
小写开头的驼峰式：$classAttribute
下划线分隔式：$class_attribute

以上三个规范，选择了一种后，建议是以项目为单位，整个项目就应该照此标准执行。

每个属性都必须添加访问修饰符。

一定不可使用关键字 var 声明一个属性。

不该使用下划线作为前缀，来区分属性是 protected 或 private。

以下是属性声明的一个范例：

<?php
namespace AppController;

class UsersController
{
    public $foo = null;
}// UsersController{} end

类方法

方法名必须符合小写开头的驼峰式命名规范。

所有方法都必须添加访问修饰符。

不该使用下划线作为前缀，来区分方法是 protected 或 private 访问修饰符。

方法名称后一定不可有空格符，其开始花括号必须独占一行，结束花括号也必须在方法主体后独占一行。参数左括号后和右括号前一定不可有空格。

一个标准的方法声明可参考一下范例，留意其括号、逗号、空格以及花括号的位置。

<?php
namespace AppController;

class UsersController
{
    public function testFunc($arg1, $arg2, $arg3 = [])
    {
        // function code
     }// testFunc() end
}// UsersController{} end

类方法的参数

参数列表中，每个逗号后面必须要有一个空格，而逗号前面一定不可有空格。

有默认值的参数，必须放到参数列表的末尾。

<?php
namespace AppController;

class UsersController
{
    public function testFunc($arg1, $arg2, $arg3 = [])
    {
        // function code
     }// testFunc() end
}// UsersController{} end

参数列表可以分列成多行，包括第一个参数在内的每个参数都必须单独成行。

拆分成多行的参数列表后，结束括号以及方法开始花括号必须写在同一行，中间用一个空格分隔。

<?php
namespace AppController;

class UsersController
{
    public function testFunc(
        string $arg1, 
        $arg2, 
        array $arg3 = []
    ) {
        // function code
     }// testFunc() end
}// UsersController{} end

abstract，final 和 static 关键字

需要添加 abstract 或 final 声明时，必须写在访问修饰符前，而 static 则必须写在其后。

<?php
namespace AppController;

abstract class UsersController
{
    protected static $var;

    abstract protected function tall();

    final public static function bar()
    {
    // function code
    }// bar() end
}// UsersController{} end

方法及函数调用

方法及函数调用时，方法名或函数名与参数左括号之间一定不可有空格，参数右括号前也一定不可有空格。每个逗号前一定不可有空格，但其后必须有一个空格。

<?php
bar();
$foo->bar($arg1);
Foo::bar($arg2, $arg3);

参数可以分列成多行，此时包括第一个参数在内的每个参数都必须单独成行。

<?php
$foo->bar(
    $arg1,
    $arg2,
    $arg3
);

类的扩展与继承

关键词 extends 和 implements 必须写在类名称的同一行。

类的开始花括号必须独占一行，结束花括号也必须在类主体后独占一行。

<?php
namespace AppController;

use BikesController;
use UserModel as User;
use AppModelsCarModel;

class UsersController extends Controller implements ArrayAccess, Countable
{
    // 这里面是常量、属性、类方法
}// UsersController{} end

implements 的继承列表也可以分成多行，每个继承接口名称都必须分开独立成行，包括第一个。

<?php
namespace AppController;

use BikesController;
use UserModel as User;
use AppModelsCarModel;

class UsersController extends Controller implements
    ArrayAccess, 
    Countable,
    Serializable
{
    // 这里面是常量、属性、类方法
}// UsersController{} end

控制结构

控制结构的基本规范如下：

控制结构关键词后必须有一个空格。
左括号“(”后一定不可有空格。
右括号“)”前也一定不可有空格。
右括号“)”与开始花括号“{”间必须有一个空格。
结构体主体必须要有一次缩进。
结构花括号“}”必须在结构体主体后单独成行。

每个结构体的主体都必须被包含在成对的花括号之中，这能让结构体更加标准化，以及减少加入新行时，出错的可能性。

if，elseif，else

标准的 if 结构如下代码所示，请留意“括号”、“空格”和“花括号”的位置，注意 else 和 elseif 都与前面的结束花括号在同一行。

<?php
if ($expr1) {
    // if body
} elseif ($expr2) {
    // elseif body
} else {
    // else body
}

应该使用关键词 elseif 代替所有 else if，以使得所有的控制关键词都像是单独的一个词。

switch，case

标准的 switch 结构如下代码所示，留意括号、空格及花括号的位置。

case 语句必须相对 switch 进行一次缩进，而 break 语句以及 case 内的其它语句都必须相对 case 进行一次缩进。

如果存在非空的 case 直穿语句，主体里必须有类似“// no break”的注释。

<?php
switch ($expr) {
    case 0:
        echo 'First case, with a break';
        break;
    case 1:
        echo 'Second case, which falls through';
        // no break
    case 2:
    case 3:
    case 4:
        echo 'Third case, return instead of break';
        return;
    default:
        echo 'Default case';
        break;
}

while，do while

一个规范的 while 语句应该如下所示，注意其“括号”、“空格”及“花括号”的位置。

<?php
while ($expr) {
    // code
}

标准的 do while 语句如下所示，注意其“括号”、“空格”及“花括号”的位置。

<?php
do {
    // code
} while ($expr);

for

标准的 for 语句如下所示，注意其“括号”、“空格”及“花括号”的位置。

<?php
for ($i = 0; $i < 10; $i++) {
    // for loop code
}

foreach

标准的 foreach 语句如下所示，注意其“括号”、“空格”及“花括号”的位置。

<?php
foreach ($array as $key => $value) {
    // foreach code
}

try，catch

标准的 try catch 语句如下所示，注意其“括号”、“空格”及“花括号”的位置。

<?php
try {
    // try body
} catch (FirstExceptionType $e) {
    // catch body
} catch (OtherExceptionType $e) {
    // catch body
}

闭包

闭包声明时，关键词 function 后和关键词 use 前后都必须要有一个空格。

开始花括号必须写在声明的同一行，结束花括号必须紧跟主体结束的下一行。

参数列表和变量列表的左括号后以及右括号前，一定不可有空格。

参数和变量列表中，逗号前一定不可有空格，而逗号后必须要有空格。

闭包中有默认值的参数必须放到列表的后面。

标准的闭包声明语句如下所示，注意其“括号”、“空格”及“花括号”的位置。

<?php
$closureWithArgs = functioin ($arg1, $arg2) {
    // body
};

$closureWithArgsAndVars = function ($arg1, $arg2) use ($var1, $var2) {
    // body
};

参数列表及变量列表可以分成多行，包括第一个在内的每个参数或变量都必须单独成行，而列表的右括号与闭包的开始花括号必须放在同一行。

以下几个例子，包含了参数和变量列表被分成多行的多情况。

<?php
$longArgs_noVars = function (
    $longArgument,
    $longerArgument,
    $muchLongerArgument
) {
    // 主体
};

$noArgs_longVars = function () use (
    $longVar1,
    $longerVar2,
    $muchLongerVar3
) {
    // 主体
};

$longArgs_longVars = function (
    $longArgument,
    $longerArgument,
    $muchLongerArgument
) use (
    $longVar1,
    $longerVar2,
    $muchLongerVar3
) {
    // 主体
};

$longArgs_shortVars = function (
    $longArgument,
    $longerArgument,
    $muchLongerArgument
) use ($var1) {
    // 主体
};

$shortArgs_longVars = function ($arg) use (
    $longVar1,
    $longerVar2,
    $muchLongerVar3
) {
    // 主体
};

注意，闭包被直接用作函数或方法调用的参数时，以上规则仍然适用。

<?php
$foo->bar(
    $arg1,
    function ($arg2) use ($var1) {
        // 主体
    },
    $arg3
);

资料来源：PHP PSR 标准规范

感谢 Summer

-- 完结 --

weixin_39617685

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
php 换行输出_PHP-基础编码规范-浅谈篇

前言：PHP 作为一种编程语言，有着自己固有的编码规范，作为程序员，使用该语言，就应该严格的遵循着它。我个人的编码习惯是会在“类”和“类方法”结束符那里加上一些备注，目的在于能够迅速的查看了区分。<?phpclass TestClass{ public function add() { // body }// add() end}// TestClas...
复制链接

扫一扫