Coding Standard

Coding Standard
Struktur
  • Denken Sie daran, nach jedem Semikolon einen einzelnen Leerzeichen einzufügen (;)
  • Fügen Sie immer einen einzelnen Leerzeichen um (vor und nach) die binären Operatoren, die Verkettung Operatoren (z. b. den Punkt (.)) (etc.). Beispiel: if (a == B)
  • Verwenden Sie einen identischen Vergleich, es sei denn, Sie müssen jonglieren.
  • Verwenden Sie immer Yoda Bedingungen, wenn Sie eine Variable bearbeiten, um versehentliche Änderungen der Werte in der Deklaration zu vermeiden, können wir auch den Datentyp automatisch überprüfen.
  • Achten Sie darauf, dass Sie nach jedem Arrayelement in einem mehrzeiligen Array, einschließlich des letzten Elements, ein Komma (,) hinzufügen.
    [
    1 = ") ' erstes Element ',
    2 = ") ' zweites Element ',
    ];
  • Hinzufügen einer Leerzeile vor jeder Return-Anweisung, ignorieren, wenn die Return-Anweisung nur in einer Anweisung Block ist
    if ($a == $b) {
    $c = $a + $b;

    Return $c;
    }

    if ($a == $b) {
    return true;
    }

  • Verwenden Sie geschweifte Klammern, um den Textkörper der Steuerelementmuster anzugeben, ungeachtet der Anzahl der darin enthaltenen Anweisungen.
  • Deklarieren Sie zuerst die öffentlichen Methoden, dann Protected und finally private. Ausnahmen von dieser Regel sind der Klassenkonstruktor und die Setup-Methoden der phpunit-Tests.
  • Die Funktion und alle zugehörigen Argumente sollten sich unabhängig von der Anzahl der Argumente in derselben Zeile bearbeiten.
  • Verwenden Sie immer Sprinf, um Ausnahmen und die Fehlermeldung zu drucken.
Konventionen der Erklärung
  • Durch Deklarieren der Variablen, der Funktion und der Argumente, verwenden Sie immer CamelCase, verwenden Sie keine Unterstriche.
  • Durch Deklarieren der optionalen Namen und die Parameter vergessen Sie nicht, die hervorgehobene
  • Verwenden Sie Namespaces für alle Klassen am oberen Rand der Klasse
  • Abstrakte Klasse sollte ein Präfix mit abstrakten
  • Die Schnittstelle sollte ein Suffix mit Schnittstelle haben, auch für die Funktionen und Ausnahmen
  • Dateinamen müssen alphanumerische Zeichen und Unterstriche enthalten
  • Immer PHPDOC für alle Funktionen oder Methoden schreiben