Kapitel 3. Coding Standards

Inhaltsverzeichnis
Einrückungen und Zeilenlänge
Kontrollstrukturen
Funktionsaufrufe
Klassen-Definition
Funktionsdefinitionen
Kommentare
Code einbinden
PHP-Code-Tags
Kopf-Kommentare
CVS-Nutzung
Beispiel-URLs
Namens-Konventionen
Dateiformate
E_STRICT-kompatibler Code
Richtlinen zur Fehlerbehandlung
Best practices
Beispieldatei inklusive Docblock-Kommentaren
Die PEAR-Werkzeugkiste

Anmerkung: Die PEAR Codings Standards gelten für Quellcode der Bestandteil der offiziellen PEAR-Distribution ist. Die Codings Standards werden meist kurz als CS bezeichnet. Ihr Ziel ist es, den Quellcode konsistent zu halten und somit es allen Beteiligten zu erleichtern den Quellcode zu lesen und zu betreuen.

Einrückungen und Zeilenlänge

Benutzen Sie Einrückungen mit 4 Leerzeichen, keine Tabulatoren. Damit helfen Sie, Probleme zu vermeiden, die mit Diffs, Patches und anderen CVS-Funktionen entstehen.

Wenn Sie Emacs benutzen, um Code in PEAR zu bearbeiten, setzen Sie die Einstellung indent-tabs-mode auf nil. Folgender Hook stellt dies sicher (Vergessen Sie nicht, dass dieser Hook auch aktiv ist, wenn Sie PHP-Dateien bearbeiten):
(defun php-mode-hook ()
  (setq tab-width 4
        c-basic-offset 4
        c-hanging-comment-ender-p nil
        indent-tabs-mode
  (not
    (and (string-match "/\\(PEAR\\|pear\\)/" (buffer-file-name))
      (string-match "\.php$" (buffer-file-name))))))

Für Vim erreichen Sie dies mit folgenden Einstellungen:
set expandtab
set shiftwidth=4
set softtabstop=4
set tabstop=4

Wir empfehlen einen Zeilenumbruch bei ca. 75 - 85 Zeichen durchzuführen, um die Lesbarkeit zu erhöhen.