PHP PSR-Spezifikation Chinesische Version_php-Grundlagen

Adresse des Dokumentenlagers: https://github.com/hfcorriez/fig-standards

PSR-Spezifikation, chinesische Version

• PSR-0 automatisches Laden
• PSR-1-Grundcodespezifikation
• PSR-2-Codestil
• PSR-3-Protokollschnittstelle

Warum die Spezifikation

Der Auszug übersetzt einen offiziellen Satz. Diese Organisation möchte unsere Codeprojekte diskutieren Gemeinsamkeiten bei der Suche nach einem kollaborativen Programmieransatz.

Das erinnert mich an diese Passage in einem Artikel „Warum Google strenge Codestandards erzwingt“:

Code kopieren Der Code lautet wie folgt:

In Google kann ich jeden Code anzeigen, alle Google-Codebibliotheken eingeben, ich habe die Berechtigung, sie anzuzeigen. Tatsächlich verfügen nur sehr wenige Menschen über diese Art von Autorität. Was mich jedoch überraschte, war, dass so viele Codierungsstandards – Einrückung, Benennung, Dateistruktur, Kommentarstil – es mir überraschend einfach machten, jeden Codeabschnitt zu lesen und ihn leicht zu verstehen. Das schockierte mich – denn ich dachte, diese Normen seien trivial. Sie hätten unmöglich so viel tun können – und doch haben sie es getan. Wenn Sie feststellen, dass Sie einen Code verstehen können, indem Sie sich nur die grundlegende Syntaxstruktur des Programms ansehen, ist diese Art der Zeitersparnis nur schockierend!

Liebe Leserinnen und Leser, mehr muss ich zu den Regelungen nicht sagen.

Schreiben Sie es am Ende
Angaben sind nicht verpflichtend. Natürlich können Sie auch Ihren eigenen Weg wählen, aber die Verwendung von Vorgaben erleichtert Ihnen die Zusammenarbeit. Heutzutage ist das Schreiben verschiedener moderner Anwendungen nicht mehr wie früher. Eine Anwendung besteht in der Regel aus vielen Modulen. Wenn die Spezifikationen nicht implementiert werden, wird das Verständnis und die Kommunikation des gesamten Projekts nur noch komplizierter.

Wenn Sie Spezifikationen verwenden, liegen die Vorteile für das Projekt und Sie selbst natürlich auf der Hand.

Alle akzeptierten Spezifikationsreferenzen: https://github.com/hfcorriez/fig-standards/tree/zh_CN/%E6%8E%A5%E5%8F%97

Codestilspezifikation

Der Zweck dieses Leitfadens besteht darin, die kognitiven Unterschiede zwischen verschiedenen Entwicklern beim Durchsuchen des Codes zu verringern. Dies listet eine Reihe allgemeiner Regeln für die Formatierung von PHP-Code auf.
Die Gemeinsamkeiten der einzelnen Mitgliedsprojekte bilden die Stilregeln dieses Artikels. Wenn verschiedene Entwickler an verschiedenen Projekten zusammenarbeiten, wird für diese verschiedenen Projekte ein gemeinsamer Standard verwendet. Daher liegt der Nutzen dieses Leitfadens nicht in den Regeln selbst, sondern darin, sie weiterzugeben.
Die charakteristischen Schlüsselwörter „MUST“, „MUST NOT“, „REQUIRED“, „SHALL“, „SHALL NOT“ in RFC 2119, die Wörter „SHOULD“, „SHOULD NOT“, „RECOMMENDED“, „MAY“ und In diesem Dokument wird „OPTIONAL“ verwendet.

1. Gliederung

Der Code muss PSR-1 entsprechen.

Der Code muss eine Einrückung von 4 Leerzeichen und keine Tabulatoren enthalten.
Es sollte keine feste Begrenzung für die Länge einer Codezeile geben; die weiche Begrenzung muss 120 Zeichen betragen; sie sollte auch 80 Zeichen oder weniger betragen.
Unter der Namespace-Deklaration muss eine Leerzeile stehen, und unter dem Verwendungsdeklarationsblock muss sich auch eine Leerzeile befinden.
Die linke geschweifte Klammer der Klasse muss in der nächsten Zeile und die rechte geschweifte Klammer muss in der nächsten Zeile des Klassenkörpers platziert werden.
Die linke geschweifte Klammer einer Methode muss in der nächsten Zeile platziert werden, und die rechte geschweifte Klammer muss unter dem Methodenkörper platziert werden.
Alle Eigenschaften und Methoden müssen über Sichtbarkeitsdeklarationen (Anmerkung des Übersetzers: Öffentlich, Schützen, Privat) verfügen; abstrakte und endgültige Deklarationen müssen vor Sichtbarkeit erfolgen; statische Deklarationen müssen nach Sichtbarkeit erfolgen.
Nach Schlüsselwörtern von Kontrollstrukturen muss ein Leerzeichen stehen; Methoden und Funktionen sind nicht zulässig.
Die linke geschweifte Klammer der Kontrollstruktur muss auf derselben Zeile platziert werden, und die rechte geschweifte Klammer muss auf der nächsten Zeile des Kontrollkörpers platziert werden.
Es dürfen keine Leerzeichen nach der linken Klammer der Kontrollstruktur und keine Leerzeichen vor der rechten Klammer stehen.

1.1. Beispiel
Dieses Beispiel enthält eine einfache Darstellung einiger der oben genannten Regeln:

Code kopieren Der Code lautet wie folgt:

Namespace VendorPackage;
FooInterface verwenden;
BarClass als Bar verwenden;
OtherVendorOtherPackageBazClass verwenden;

Klasse Foo erweitert Bar implementiert FooInterface
{
öffentliche Funktion sampleFunction($a, $b = null)
{
if ($a === $b) {
bar ();
} elseif ($a > $b) {
                                                                              );
}
}

final public static function bar() {

// Methodenkörper
}
}

2. Zusammenfassung2.1 Grundlegende Codespezifikationen

Der Code muss allen Regeln von PSR-1 entsprechen.

2.2 Dateien

Alle PHP-Dateien müssen Unix LF (Zeilenvorschub) als Zeilenabschlusszeichen verwenden.

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

Dateiabschluss-Tag für reinen PHP-Code?>Muss weggelassen werden

2.3. Zeile

Es kann keine feste Begrenzung der Zeilenlänge geben.

Die Soft-Grenze für die Zeilenlänge muss 120 Zeichen betragen; für die Soft-Grenze muss die automatische Stilprüfung eine Warnung, aber keine Fehlermeldung ausgeben.

Die tatsächliche Zeilenlänge sollte 80 Zeichen nicht überschreiten; längere Zeilen sollten in mehrere aufeinanderfolgende Zeilen mit nicht mehr als 80 Zeichen aufgeteilt werden.

Nach nicht leeren Zeilen dürfen keine Leerzeichen stehen.

Leerzeilen können verwendet werden, um die Lesbarkeit zu verbessern und zusammengehörige Codeblöcke zu unterscheiden.

Es sollte nicht mehr als eine Aussage pro Zeile geben.

2.4. Einrückung

Der Code muss 4 Leerzeichen für die Einrückung verwenden und Tabulatorzeichen können nicht als Einrückung verwendet werden.

Hinweis: Die ausschließliche Verwendung von Leerzeichen, nicht gemischt mit Tabulatoren, trägt dazu bei, einige Probleme bei Codeunterschieden, Patches, Verlauf und Kommentaren zu vermeiden. Durch die Verwendung von Leerzeichen ist es auch sehr einfach, subtile Einrückungen anzupassen, um die Ausrichtung zwischen Zeilen zu verbessern.

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

PHP-Schlüsselwörter müssen in Kleinbuchstaben geschrieben werden.

PHP-Konstanten true, false und null müssen Kleinbuchstaben sein.

3. Namespace- und Verwendungsdeklarationen

Falls vorhanden, muss nach der Namespace-Deklaration eine Leerzeile stehen.

Falls vorhanden, müssen alle Use-Anweisungen unterhalb der Namespace-Anweisung platziert werden.

Ein use-Schlüsselwort darf nur in einer Deklaration verwendet werden.

Nach dem Verwendungsdeklarationsblock muss eine Leerzeile stehen.

Beispiel:

Code kopieren Der Code lautet wie folgt:

Namespace VendorPackage ;

FooClass verwenden;

BarClass als Bar verwenden;

OtherVendorOtherPackageBazClass verwenden;

// ... zusätzlicher PHP-Code ...

4. Klassen, Eigenschaften und Methoden

Der Begriff „Klasse“ bezieht sich auf alle Klassen, Schnittstellen und Merkmale.

4.1. Erweiterung und Vererbung

Die Schlüsselwörter „extends“ und „implements“ einer Klasse müssen in derselben Zeile wie der Klassenname stehen.

Die linke geschweifte Klammer der Klasse muss in einer eigenen Zeile darunter platziert werden; die rechte geschweifte Klammer muss in einer eigenen Zeile nach dem Klassenkörper platziert werden.

Code kopieren Der Code lautet wie folgt:

Namespace VendorPackage ;
verwende FooClass;
verwende BarClass als Bar;
verwende OtherVendorOtherPackageBazClass;

Klasse ClassName erweitert ParentClass implementiert ArrayAccess, Countable

{

// Konstanten, Eigenschaften, Methoden
}