Detaillierte Einführung in die PSR-2-Codierungsstilspezifikation von PHP (Code)

Der Inhalt dieses Artikels ist eine detaillierte Einführung (Code) über die PSR-2-Codierungsstilspezifikation. Ich hoffe, dass er Ihnen helfen wird .

Als nächstes folgt die PSR-2-Codierungsstilspezifikation, die die Vererbung und Erweiterung der PSR-1-Basiscodierungsspezifikation darstellt.

PSR-1 und PSR-2 sind die grundlegenden Codierungsstandards in der PHP-Entwicklung. Tatsächlich kann jeder auf sie zurückgreifen und daraus lernen, obwohl jeder Entwickler seine eigenen Entwicklungsstandards hat, mit denen er vertraut ist. Ich denke, es ist immer noch so, dass wir unseren Code gemäß den Industriestandards schreiben. Ich hoffe, dass es für PHP-Entwickler hilfreich sein wird.

1. Übersicht

Der Code muss den Codierungsspezifikationen in [PSR-1]() entsprechen.

Code muss mit 4 Leerzeichen anstelle der „Tab-Taste“ eingerückt werden.

Die Anzahl der Zeichen pro Zeile sollte sanft bei 80 liegen. Theoretisch darf sie nicht mehr als 120 betragen, es darf aber keine feste Grenze geben.

Nach jeder Namespace-Deklarationsanweisung und jedem Use-Deklarationsblock muss eine Leerzeile eingefügt werden.

Die öffnende geschweifte Klammer ({) einer Klasse muss in einer eigenen Zeile nach der Klassendeklaration geschrieben werden, und die schließende geschweifte Klammer (}) muss ebenfalls in einer eigenen Zeile nach dem Klassenkörper geschrieben werden.

Die öffnende geschweifte Klammer ({) der Methode muss in einer eigenen Zeile nach der Funktionsdeklaration geschrieben werden, und die schließende geschweifte Klammer (}) muss ebenfalls in einer eigenen Zeile nach dem Funktionskörper geschrieben werden.

Die Attribute und Methoden der Klasse müssen Zugriffsmodifikatoren hinzufügen (privat, geschützt und öffentlich), abstrakt und final müssen vor dem Zugriffsmodifikator deklariert werden und statisch muss nach dem Zugriffsmodifikator deklariert werden.

Nach dem Schlüsselwort der Kontrollstruktur muss ein Leerzeichen stehen, beim Aufruf einer Methode oder Funktion darf es jedoch nicht sein.

Die öffnende geschweifte Klammer ({) der Kontrollstruktur muss in derselben Zeile wie die Deklaration geschrieben werden, und die schließende geschweifte Klammer (}) muss in einer eigenen Zeile nach dem Text geschrieben werden.

Nach der öffnenden linken Klammer und vor der schließenden rechten Klammer der Kontrollstruktur dürfen keine Leerzeichen stehen.

1.1. Beispiel

Das folgende Beispielprogramm demonstriert einfach die meisten der oben genannten Spezifikationen:

<?php
namespace Vendor\Package;
use FooInterface;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;
class Foo extends Bar implements FooInterface
{
 public function sampleFunction($a, $b = null)
 {
 if ($a === $b) {
 bar();
 } elseif ($a > $b) {
 $foo->bar($arg1);
 } else {
 BazClass::bar($arg2, $arg3);
 }
 }
 final public static function bar()
 {
 // 方法的内容
 }
}

Allgemeine Regeln

2.1 Grundlegende Codierungsrichtlinien

Der Code muss allen Spezifikationen in [PSR-1]() entsprechen.

2.2 Dateien

Alle PHP-Dateien müssen Unix LF (Linefeed) als Zeilenabschluss verwenden.

Alle PHP-Dateien müssen mit einer Leerzeile enden.

In reinen PHP-Codedateien muss das abschließende ?> weggelassen werden.

2.3. Die Länge der Linie

darf keine harten Einschränkungen haben.

Weiche Längenbeschränkungen müssen auf 120 Zeichen begrenzt werden. Wenn diese Länge überschritten wird, muss der Editor mit Codespezifikationsprüfung eine Warnung ausgeben, darf jedoch keine Fehlermeldung ausgeben.

Jede Zeile sollte 80 Zeichen nicht überschreiten und Zeilen mit mehr als 80 Zeichen sollten in mehrere Zeilen zusammengefasst werden.

Nach einer nicht leeren Zeile dürfen keine zusätzlichen Leerzeichen stehen.

Leerzeilen können das Lesen des Codes erleichtern und dabei helfen, den Code aufzuteilen.

Es darf nicht mehr als eine Aussage pro Zeile geben.

2.4. Einrückung

Der Code muss mit 4 Leerzeichen eingerückt werden und die Tabulatortaste darf nicht verwendet werden.

Hinweis: Der Vorteil der Verwendung von Leerzeichen anstelle von „Tab-Einrückungen“ besteht darin, dass

Verwirrung beim Vergleich von Codeunterschieden, beim Patchen, beim Überprüfen von Code und bei Kommentaren vermieden wird.

Verwenden Sie außerdem Leerzeichen zum Einrücken, um die Ausrichtung zu erleichtern.

2.5. Schlüsselwörter und Wahr/Falsch/Null

Alle PHP-Schlüsselwörter müssen ausschließlich in Kleinbuchstaben geschrieben sein.

Die Konstanten true, false und null müssen ebenfalls alle in Kleinbuchstaben geschrieben sein.

3. Namensraum- und Nutzungsdeklarationen

Nach der Namensraumdeklaration muss eine Leerzeile eingefügt werden.

Alle Verwendungen müssen nach dem Namespace deklariert werden.

Jede use-Anweisung darf nur ein use-Schlüsselwort haben.

Nach der Deklaration des use-Anweisungsblocks muss eine Leerzeile vorhanden sein.

Zum Beispiel:

<?php

namespace Vendor\Package;
use FooClass;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;

4. Klassen, Eigenschaften und Methoden

Die „Klasse“ bezieht sich hier auf alle „Klassenklassen“, „Schnittstellen“. „ und „Eigenschaften wiederverwendbarer Codeblöcke“.

4.1. Erweiterung und Vererbung

Die Schlüsselwörter „extends“ und „implements“ müssen in derselben Zeile des Klassennamens geschrieben werden.

Die öffnende geschweifte Klammer einer Klasse muss eine eigene Zeile einnehmen, und die schließende geschweifte Klammer muss ebenfalls eine eigene Zeile nach dem Klassenkörper einnehmen. Die Vererbungsliste von

<?php
namespace Vendor\Package;
use FooClass;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;
class ClassName extends ParentClass implements \ArrayAccess, \Countable
{
 // 这里面是常量、属性、类方法
}

Implementierungen kann auch in mehrere Zeilen aufgeteilt werden. In diesem Fall muss jeder geerbte Schnittstellenname in einer eigenen Zeile stehen, einschließlich der ersten.

<?php

namespace Vendor\Package;
use FooClass;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;
class ClassName extends ParentClass implements
 \ArrayAccess,
 \Countable,
 \Serializable
{
 // 这里面是常量、属性、类方法
}

4.2. Attribute

Jedem Attribut müssen Zugriffsmodifikatoren hinzugefügt werden.

Das Schlüsselwort var darf nicht zum Deklarieren einer Eigenschaft verwendet werden.

每条语句 一定不可 定义超过一个属性。

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

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

<?php
namespace Vendor\Package;
class ClassName
{
 public $foo = null;
}

4.3方法

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

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

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

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

<?php
namespace Vendor\Package;
class ClassName
{
 public function fooBarBaz($arg1, &$arg2, $arg3 = [])
 {
 // method body
 }
}

4.4. 方法的参数

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

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

<?php
namespace Vendor\Package;
class ClassName
{
 public function foo($arg1, &$arg2, $arg3 = [])
 {
 // method body
 }
}

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

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

<?php
namespace Vendor\Package;
class ClassName
{
 public function aVeryLongMethodName(
 ClassTypeHint $arg1,
 &$arg2,
 array $arg3 = []
 ) {
 // 方法的内容
 }
}

4.5. abstract 、 final 、 以及 static

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

<?php
namespace Vendor\Package;
abstract class ClassName
{
 protected static $foo;
 abstract protected function zim();
 final public static function bar()
 {
 // method body
 }
}

4.6. 方法及函数调用

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

<?php
bar();
$foo->bar($arg1);
Foo::bar($arg2, $arg3);
参数 可以 分列成多行，此时包括第一个参数在内的每个参数都 必须 单独成行。
<?php
$foo->bar(
 $longArgument,
 $longerArgument,
 $muchLongerArgument
);

5. 控制结构

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

• 控制结构关键词后 必须 有一个空格。

• 左括号 ( 后 一定不可 有空格。

• 右括号 ) 前也 一定不可 有空格。

• 右括号 ) 与开始花括号 { 间 必须 有一个空格。

• 结构体主体 必须 要有一次缩进。

• 结束花括号 } 必须 在结构体主体后单独成行。

每个结构体的主体都 必须 被包含在成对的花括号之中，

这能让结构体更加结构话，以及减少加入新行时，出错的可能性。

5.1. if 、elseif 和 else

标准的 if 结构如下代码所示，请留意「括号」、「空格」以及「花括号」的位置，

注意 else 和 elseif 都与前面的结束花括号在同一行。

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

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

5.2. switch 和 case

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

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

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

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

5.3. while 和 do while

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

<?php
while ($expr) {
 // structure body
}

标准的 do while 语句如下所示，同样的，注意其「括号」、「空格」以及「花括号」的位置。

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

5.4. for

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

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

5.5. foreach

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

<?php
foreach ($iterable as $key => $value) {
 // foreach body
}

5.6. try, catch

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

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

6. 闭包

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

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

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

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

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

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

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

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

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

<?php
$longArgs_noVars = function (
 $longArgument,
 $longerArgument,
 $muchLongerArgument
) {
 // body
};
$noArgs_longVars = function () use (
 $longVar1,
 $longerVar2,
 $muchLongerVar3
) {
 // body
};
$longArgs_longVars = function (
 $longArgument,
 $longerArgument,
 $muchLongerArgument
) use (
 $longVar1,
 $longerVar2,
 $muchLongerVar3
) {
 // body
};
$longArgs_shortVars = function (
 $longArgument,
 $longerArgument,
 $muchLongerArgument
) use ($var1) {
 // body
};
$shortArgs_longVars = function ($arg) use (
 $longVar1,
 $longerVar2,
 $muchLongerVar3
) {
 // body
};

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

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

【推荐课程：PHP视频教程】

Das obige ist der detaillierte Inhalt vonDetaillierte Einführung in die PSR-2-Codierungsstilspezifikation von PHP (Code). Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!